Skip to content

Commit 14a5c0f

Browse files
blvafmenezes
authored andcommitted
chore: update readme
1 parent 8aafba5 commit 14a5c0f

File tree

1 file changed

+40
-16
lines changed

1 file changed

+40
-16
lines changed

README.md

Lines changed: 40 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,40 +5,52 @@ TBD
55
=======
66
# Atlas MCP Server PoC
77

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)
1724
- [VSCode](#vscode)
1825
- [Claude](#claude)
1926

27+
## 🚀 Getting Started
2028

21-
## Setting up your environment
29+
### Prerequisites
30+
- Node.js installed
31+
- MongoDB Atlas account
32+
33+
### Installation
2234

2335
```shell
2436
npm install
2537
```
2638

27-
## Running the MCP Server
39+
### Running the MCP Server
2840

2941
```shell
3042
npm run build
3143
```
3244

33-
## Troubleshooting (Via VSCode Insiders)
45+
## 🔧 Troubleshooting
3446

35-
### Restart server
47+
### Restart Server
3648
- Run `npm run build` to re-build the server if you made changes to the code
3749
- Press `Cmd + Shift + P` and type List MCP Servers
3850
- Select the MCP server you want to restart
3951
- Select the option to restart the server
4052

41-
### Logs
53+
### View Logs
4254
To see MCP logs, check https://code.visualstudio.com/docs/copilot/chat/mcp-servers.
4355

4456
- Press `Cmd + Shift + P` and type List MCP Servers
@@ -51,10 +63,22 @@ We can use @modelcontextprotocol/inspector to debug the server - https://github.
5163

5264
From the root of this repository, run:
5365
```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
5572
```
5673

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!)
5882

5983
### VSCode
6084

0 commit comments

Comments
 (0)