Skip to content

chore: update docs #169

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Apr 29, 2025
Merged

chore: update docs #169

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2e48280
chore: update docs
blva Apr 29, 2025
277720a
format
blva Apr 29, 2025
a621548
Merge branch 'main' into docs
blva Apr 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,8 +150,9 @@ The MongoDB MCP Server can be configured using multiple methods, with the follow
| `apiClientSecret` | Atlas API client secret for authentication |
| `connectionString` | MongoDB connection string for direct database connections (optional users may choose to inform it on every tool call) |
| `logPath` | Folder to store logs |
| `disabledTools` | An array of tool names, operation types, and/or categories of tools that will be disabled. |
| `disabledTools` | An array of tool names, operation types, and/or categories of tools that will be disabled |
Copy link
Preview

Copilot AI Apr 29, 2025

Choose a reason for hiding this comment

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

[nitpick] The removal of the trailing period in the 'disabledTools' description differs from similar entries. Consider standardizing punctuation across all configuration entries for consistency.

Suggested change
| `disabledTools` | An array of tool names, operation types, and/or categories of tools that will be disabled |
| `disabledTools` | An array of tool names, operation types, and/or categories of tools that will be disabled. |

Copilot uses AI. Check for mistakes.

| `readOnly` | When set to true, only allows read and metadata operation types, disabling create/update/delete operations |
| `telemetry` | When set to disabled, disables telemetry collection |

#### `logPath`

Expand Down Expand Up @@ -196,6 +197,16 @@ You can enable read-only mode using:

When read-only mode is active, you'll see a message in the server logs indicating which tools were prevented from registering due to this restriction.

#### Telemetry

The `telemetry` configuration option allows you to disable telemetry collection. When enabled, the MCP server will collect usage data and send it to MongoDB.

You can disable telemetry using:

- **Environment variable**: `export MDB_MCP_TELEMETRY=disabled`
- **Command-line argument**: `--telemetry disabled`
- **DO_NOT_TRACK environment variable**: `export DO_NOT_TRACK=1`

### Atlas API Access

To use the Atlas API tools, you'll need to create a service account in MongoDB Atlas:
Expand Down
Loading