From 9e948799f8a116420161f4d7eb53a4a1a475a72d Mon Sep 17 00:00:00 2001 From: Bianca Lisle Date: Tue, 6 May 2025 10:13:01 +0100 Subject: [PATCH 1/3] chore: update docs with more Service Accounts mentions --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 82d577d..c66e766 100644 --- a/README.md +++ b/README.md @@ -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,7 +243,7 @@ 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 +# Set Atlas API credentials (via Service Accounts) export MDB_MCP_API_CLIENT_ID="your-atlas-client-id" export MDB_MCP_API_CLIENT_SECRET="your-atlas-client-secret" From 722725a2edf707f7b6357fd378870b905537dddd Mon Sep 17 00:00:00 2001 From: Bianca Lisle Date: Tue, 6 May 2025 10:14:08 +0100 Subject: [PATCH 2/3] update --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index c66e766..d427efe 100644 --- a/README.md +++ b/README.md @@ -244,8 +244,8 @@ Set environment variables with the prefix `MDB_MCP_` followed by the option name ```shell # Set Atlas API credentials (via Service Accounts) -export MDB_MCP_API_CLIENT_ID="your-atlas-client-id" -export MDB_MCP_API_CLIENT_SECRET="your-atlas-client-secret" +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:password@cluster.mongodb.net/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:password@cluster.mongodb.net/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:password@cluster.mongodb.net/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" ] } } From ab594cde687788a5dffe298b33185d35f3c49cdb Mon Sep 17 00:00:00 2001 From: Bianca Lisle <40155621+blva@users.noreply.github.com> Date: Tue, 6 May 2025 10:20:45 +0100 Subject: [PATCH 3/3] Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d427efe..a4d5c27 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ node -v ``` - A MongoDB connection string or Atlas API credentials, **_the Server will not start unless configured_**. - - **_ 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. + - **_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