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.

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

merged 3 commits into from
Apr 29, 2025

Conversation

blva
Copy link
Collaborator

@blva blva commented Apr 29, 2025

  • adds telemetry info

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

@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 documentation by refining the configuration table entries and adding a new Telemetry section with instructions on how to disable telemetry collection.

  • Removed trailing punctuation in the "disabledTools" description for consistency.
  • Added a new "Telemetry" section detailing environment variable and command-line argument options.

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

@blva blva merged commit 308b348 into main Apr 29, 2025
14 checks passed
@blva blva deleted the docs branch April 29, 2025 16:19
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.

2 participants