Skip to content

chore: update config docs #170

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

chore: update config docs #170

wants to merge 3 commits into from

Conversation

blva
Copy link
Collaborator

@blva blva commented Apr 29, 2025

Closes #171

@blva blva marked this pull request as ready for review April 29, 2025 16:56
@Copilot Copilot AI review requested due to automatic review settings April 29, 2025 16:56
@blva blva requested a review from a team as a code owner April 29, 2025 16:56
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

"servers": {
"MongoDB": {
"command": "npx",
"args": ["-y", "mongodb-mcp-server"]

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@blva - as i understood, if you don't have the atlas API token OR a connection string here, the server will basically not start, correct?

@GaurabAryal
Copy link

GaurabAryal commented Apr 29, 2025

@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.

"mongodb-mcp-server",
"--connectionString",
"mongodb+srv://username:password@cluster.mongodb.net/myDatabase",
"--logPath",

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should remove the log arg this since it is an optional argument

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update docs with more examples on how to setup MCP
3 participants