5
5
=======
6
6
# Atlas MCP Server PoC
7
7
8
- - Uses the official MCP SDK https://github.com/modelcontextprotocol/typescript-sdk
9
-
10
- ## Table of Contents
11
- - [ Setting up your environment] ( #setting-up-your-environment )
12
- - [ Running the MCP Server] ( #running-the-mcp-server )
13
- - [ Troubleshooting (Via VSCode Insiders)] ( #troubleshooting-via-vscode-insiders )
14
- - [ Restart server] ( #restart-server )
15
- - [ Logs] ( #logs )
16
- - [ Supported tools] ( #supported-tools )
8
+ A Model Context Protocol server for interacting with MongoDB Atlas.
9
+
10
+ Developed using the official MCP SDK https://github.com/modelcontextprotocol/typescript-sdk
11
+
12
+ ## 📚 Table of Contents
13
+ - [ 🚀 Getting Started] ( #getting-started )
14
+ - [ Prerequisites] ( #prerequisites )
15
+ - [ Installation] ( #installation )
16
+ - [ Running the MCP Server] ( #running-the-mcp-server )
17
+ - [ 🔧 Troubleshooting] ( #troubleshooting )
18
+ - [ Restart Server] ( #restart-server )
19
+ - [ View Logs] ( #view-logs )
20
+ - [ Debugging] ( #debugging )
21
+ - [ 🛠️ Supported Tools] ( #supported-tools )
22
+ - [ Tool List] ( #tool-list )
23
+ - [ 👩💻 Client Integration] ( #client-integration )
17
24
- [ VSCode] ( #vscode )
18
25
- [ Claude] ( #claude )
19
26
27
+ ## 🚀 Getting Started
20
28
21
- ## Setting up your environment
29
+ ### Prerequisites
30
+ - Node.js installed
31
+ - MongoDB Atlas account
32
+
33
+ ### Installation
22
34
23
35
``` shell
24
36
npm install
25
37
```
26
38
27
- ## Running the MCP Server
39
+ ### Running the MCP Server
28
40
29
41
``` shell
30
42
npm run build
31
43
```
32
44
33
- ## Troubleshooting (Via VSCode Insiders)
45
+ ## 🔧 Troubleshooting
34
46
35
- ### Restart server
47
+ ### Restart Server
36
48
- Run ` npm run build ` to re-build the server if you made changes to the code
37
49
- Press ` Cmd + Shift + P ` and type List MCP Servers
38
50
- Select the MCP server you want to restart
39
51
- Select the option to restart the server
40
52
41
- ### Logs
53
+ ### View Logs
42
54
To see MCP logs, check https://code.visualstudio.com/docs/copilot/chat/mcp-servers .
43
55
44
56
- Press ` Cmd + Shift + P ` and type List MCP Servers
@@ -51,10 +63,22 @@ We can use @modelcontextprotocol/inspector to debug the server - https://github.
51
63
52
64
From the root of this repository, run:
53
65
``` shell
54
- npx @modelcontextprotocol/inspector dist/index.js
66
+ npx @modelcontextprotocol/inspector -- node dist/index.js
67
+ ```
68
+
69
+ Or use the npm script:
70
+ ``` shell
71
+ npm run inspect
55
72
```
56
73
57
- ## Supported tools
74
+ ## 🛠️ Supported Tools
75
+
76
+ ### Tool List
77
+ - ` auth ` - Authenticate to MongoDB Atlas
78
+ - ` list-clusters ` - Lists MongoDB Atlas clusters
79
+ - ` list-projects ` - Lists MongoDB Atlas projects
80
+
81
+ ## 👩💻 Client Integration (Use the server!)
58
82
59
83
### VSCode
60
84
0 commit comments