-
Notifications
You must be signed in to change notification settings - Fork 97
chore: update docs with more Service Accounts mentions #209
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
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -29,7 +29,7 @@ node -v | |
``` | ||
|
||
- A MongoDB connection string or Atlas API credentials, **_the Server will not start unless configured_**. | ||
- **_Atlas API credentials_** are required to use the Atlas tools. You can create a service account in MongoDB Atlas and use its credentials for authentication. See [Atlas API Access](#atlas-api-access) for more details. | ||
- **_ Service Accounts Atlas API credentials_** are required to use the Atlas tools. You can create a service account in MongoDB Atlas and use its credentials for authentication. See [Atlas API Access](#atlas-api-access) for more details. | ||
- If you have a MongoDB connection string, you can use it directly to connect to your MongoDB instance. | ||
|
||
## Setup | ||
|
@@ -67,7 +67,7 @@ You can pass your connection string via args, make sure to use a valid username | |
|
||
#### Option 2: Atlas API credentials args | ||
|
||
Use your Atlas API Service Account credentials. More details in the [Atlas API Access](#atlas-api-access) section. | ||
Use your Atlas API Service Accounts credentials. More details in the [Atlas API Access](#atlas-api-access) section. | ||
|
||
```json | ||
{ | ||
|
@@ -78,9 +78,9 @@ Use your Atlas API Service Account credentials. More details in the [Atlas API A | |
"-y", | ||
"mongodb-mcp-server", | ||
"--apiClientId", | ||
"your-atlas-client-id", | ||
"your-atlas-service-accounts-client-id", | ||
"--apiClientSecret", | ||
"your-atlas-client-secret" | ||
"your-atlas-service-accounts-client-secret" | ||
] | ||
} | ||
} | ||
|
@@ -243,9 +243,9 @@ To learn more about Service Accounts, check the [MongoDB Atlas documentation](ht | |
Set environment variables with the prefix `MDB_MCP_` followed by the option name in uppercase with underscores: | ||
|
||
```shell | ||
# Set Atlas API credentials | ||
export MDB_MCP_API_CLIENT_ID="your-atlas-client-id" | ||
export MDB_MCP_API_CLIENT_SECRET="your-atlas-client-secret" | ||
# Set Atlas API credentials (via Service Accounts) | ||
export MDB_MCP_API_CLIENT_ID="your-atlas-service-accounts-client-id" | ||
export MDB_MCP_API_CLIENT_SECRET="your-atlas-service-accounts-client-secret" | ||
|
||
# Set a custom MongoDB connection string | ||
export MDB_MCP_CONNECTION_STRING="mongodb+srv://username:[email protected]/myDatabase" | ||
|
@@ -281,8 +281,8 @@ export MDB_MCP_LOG_PATH="/path/to/logs" | |
"command": "npx", | ||
"args": ["-y", "mongodb-mcp-server"], | ||
"env": { | ||
"MDB_MCP_API_CLIENT_ID": "your-atlas-client-id", | ||
"MDB_MCP_API_CLIENT_SECRET": "your-atlas-client-secret" | ||
"MDB_MCP_API_CLIENT_ID": "your-atlas-service-accounts-client-id", | ||
"MDB_MCP_API_CLIENT_SECRET": "your-atlas-service-accounts-client-secret" | ||
} | ||
} | ||
} | ||
|
@@ -294,7 +294,7 @@ export MDB_MCP_LOG_PATH="/path/to/logs" | |
Pass configuration options as command-line arguments when starting the server: | ||
|
||
```shell | ||
npx -y mongodb-mcp-server --apiClientId="your-atlas-client-id" --apiClientSecret="your-atlas-client-secret" --connectionString="mongodb+srv://username:[email protected]/myDatabase" --logPath=/path/to/logs | ||
npx -y mongodb-mcp-server --apiClientId="your-atlas-service-accounts-client-id" --apiClientSecret="your-atlas-service-accounts-client-secret" --connectionString="mongodb+srv://username:[email protected]/myDatabase" --logPath=/path/to/logs | ||
``` | ||
|
||
#### MCP configuration file examples | ||
|
@@ -328,9 +328,9 @@ npx -y mongodb-mcp-server --apiClientId="your-atlas-client-id" --apiClientSecret | |
"-y", | ||
"mongodb-mcp-server", | ||
"--apiClientId", | ||
"your-atlas-client-id", | ||
"your-atlas-service-accounts-client-id", | ||
"--apiClientSecret", | ||
"your-atlas-client-secret" | ||
"your-atlas-service-accounts-client-secret" | ||
] | ||
} | ||
} | ||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.