chore: update config docs #170
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR updates the configuration documentation in the README to include detailed setup instructions and examples for both WindSurf and existing tools. Key changes include:
- Introducing a new WindSurf section in the navigation and content.
- Providing detailed JSON configuration examples for environment variables and command-line arguments.
- Updating the VSCode and Claude Desktop sections to use proper setup instructions instead of outdated references.
Comments suppressed due to low confidence (1)
README.md:282
- [nitpick] The section 'MCP configuration file examples' appears twice with similar content. Consider merging these sections into one with distinct subsections to reduce redundancy and improve clarity.
#### MCP configuration file examples
|
@blva – could we also remove the caution banner in the readme as part of this update? Windsurf template is going live tomorrow EOD so we should get this merged before that. |
|
we have Windsurf, VSCode and Claude Desktop, how about adding Cursor? |
There was a problem hiding this comment.
Pull Request Overview
This PR updates the configuration documentation for the MongoDB MCP Server to improve clarity and provide additional examples for various configuration methods.
- Updated introduction and description for connecting to MongoDB Databases and MongoDB Atlas
- Added detailed examples for setting up the server via environment variables and command-line arguments
- Revised the table of contents to better organize configuration options
| @@ -250,6 +250,41 @@ export MDB_MCP_LOG_PATH="/path/to/logs" | |||
|
|
|||
| ``` | |||
|
|
|||
| #### MCP configuration file examples | |||
There was a problem hiding this comment.
The section title 'MCP configuration file examples' is used again at a later section (line 296). Consider consolidating these examples or using distinct subheadings to clearly differentiate between configuration methods for environment variables and command-line arguments.
| #### MCP configuration file examples | |
| #### MCP configuration file examples (Environment Variables) |
Copilot uses AI. Check for mistakes.
README.md
Outdated
| - Input command `npx -y mongodb-mcp-server`. | ||
| - Choose between user / workspace | ||
| - Add arguments to the file | ||
| - **Windsurf**: On MacOS, save the file in `~/.codeium/windsurf/mcp_config.json` or check the[latest instructions](https://docs.windsurf.com/windsurf/mcp) for your environment |
There was a problem hiding this comment.
[q] Windsurf is the only one that has macos instructions, is there a reason?
Closes #171