Skip to content

Commit c5d5c13

Browse files
committed
chore: update config docs
1 parent 308b348 commit c5d5c13

File tree

1 file changed

+36
-5
lines changed

1 file changed

+36
-5
lines changed

README.md

Lines changed: 36 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ A Model Context Protocol server for interacting with MongoDB Atlas. This project
1010
- [🚀 Getting Started](#getting-started)
1111
- [Prerequisites](#prerequisites)
1212
- [Installation](#installation)
13+
- [WindSurf](#windsurf)
1314
- [VSCode](#vscode)
1415
- [Claude Desktop](#claude)
1516
- [🛠️ Supported Tools](#supported-tools)
@@ -19,6 +20,7 @@ A Model Context Protocol server for interacting with MongoDB Atlas. This project
1920
- [Atlas API Access](#atlas-api-access)
2021
- [Configuration Methods](#configuration-methods)
2122
- [👩‍💻 Client Integration](#client-integration)
23+
- [WindSurf](#windsurf)
2224
- [VSCode](#vscode)
2325
- [Claude](#claude)
2426
- [🤝 Contributing](#contributing)
@@ -30,6 +32,38 @@ A Model Context Protocol server for interacting with MongoDB Atlas. This project
3032

3133
## Installation
3234

35+
36+
37+
### WindSurf
38+
39+
Prerequisites:
40+
41+
- Node.js v20.x
42+
- WindSurf installed on your machine
43+
44+
The latest instructions can be found at https://docs.windsurf.com/windsurf/mcp
45+
46+
Step 1: Create MCP configuration file
47+
48+
49+
Create or edit the configuration file at `~/.codeium/windsurf/mcp_config.json`:
50+
51+
```json
52+
{
53+
"servers": {
54+
"MongoDB": {
55+
"command": "npx",
56+
"args": [
57+
"-y",
58+
"mongodb-mcp-server"
59+
]
60+
}
61+
}
62+
}
63+
```
64+
65+
Step 2: Follow the [configuration](#configuration) section for more details on how to connect to a MongoDB instance or Atlas.
66+
3367
### VSCode
3468

3569
Prerequisites:
@@ -61,11 +95,8 @@ Note: the file should look like:
6195
}
6296
```
6397

64-
Notes: You can configure the server with atlas access, make sure to follow configuration section for more details.
65-
66-
Step 2: Try talking to github copilot
98+
Step 2: Follow the [configuration](#configuration) section for more details on how to connect to a MongoDB instance or Atlas.
6799

68-
- Can you connect to my mongodb instance?
69100

70101
### Claude Desktop
71102

@@ -90,7 +121,7 @@ Paste the mcp server configuration into the file
90121

91122
Step 3: Close and Relaunch Claude Desktop and click on the hammer icon, the MongoDB MCP server should be detected.
92123

93-
You may experiment asking `Can you connect to my mongodb instance?`.
124+
Follow the [configuration](#configuration) section for more details on how to connect to a MongoDB instance or Atlas.
94125

95126
## 🛠️ Supported Tools
96127

0 commit comments

Comments
 (0)