Skip to content

Commit 39e80e8

Browse files
committed
chore: adds docs written by filipe into readme
1 parent 24ec6e5 commit 39e80e8

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

README.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,52 @@
1+
<<<<<<< HEAD
12
# atlas-mcp-server
23

34
TBD
5+
=======
6+
# Atlas MCP Server PoC
7+
8+
## Setting up your environment
9+
10+
```shell
11+
npm install
12+
```
13+
14+
## Running the MCP Server
15+
16+
```shell
17+
npm run build
18+
```
19+
20+
## Supported tools
21+
22+
### Claude
23+
24+
Step 1: Install claude and login
25+
```shell
26+
brew install claude
27+
```
28+
29+
Step 2: Create a configuration file for your MCP server
30+
31+
Open the file
32+
```
33+
code ~/Library/Application\ Support/Claude/claude_desktop_config.json
34+
```
35+
36+
Paste the mcp server configuration into the file
37+
```
38+
{
39+
"mcpServers": {
40+
"Demo": {
41+
"command": "path/to/this/repo/atlas-mc-server/dist/index.js"
42+
}
43+
}
44+
}
45+
```
46+
47+
Step 3: Launch Claude Desktop and click on the hammer icon, the Demo MCP server should be detected. Type in the chat "show me a demo of MCP" and allow the tool to get access.
48+
- Detailed instructions with screenshots can be found in this [document](https://docs.google.com/document/d/1_C8QBMZ5rwImV_9v4G96661OqcBk1n1SfEgKyNalv9c/edit?tab=t.2hhewstzj7ck#bookmark=id.nktw0lg0fn7t).
49+
50+
51+
Note: If you make changes to your MCP server code, rebuild the project with `npm run build` and restart the server and Claude Desktop.
52+
>>>>>>> 1599834 (chore: adds docs written by filipe into readme)

0 commit comments

Comments
 (0)