Skip to content

Commit 119a78a

Browse files
authored
chore: update docs with more Service Accounts mentions (#209)
1 parent 8760d86 commit 119a78a

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ node -v
2929
```
3030

3131
- A MongoDB connection string or Atlas API credentials, **_the Server will not start unless configured_**.
32-
- **_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.
32+
- **_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.
3333
- If you have a MongoDB connection string, you can use it directly to connect to your MongoDB instance.
3434

3535
## Setup
@@ -67,7 +67,7 @@ You can pass your connection string via args, make sure to use a valid username
6767

6868
#### Option 2: Atlas API credentials args
6969

70-
Use your Atlas API Service Account credentials. More details in the [Atlas API Access](#atlas-api-access) section.
70+
Use your Atlas API Service Accounts credentials. More details in the [Atlas API Access](#atlas-api-access) section.
7171

7272
```json
7373
{
@@ -78,9 +78,9 @@ Use your Atlas API Service Account credentials. More details in the [Atlas API A
7878
"-y",
7979
"mongodb-mcp-server",
8080
"--apiClientId",
81-
"your-atlas-client-id",
81+
"your-atlas-service-accounts-client-id",
8282
"--apiClientSecret",
83-
"your-atlas-client-secret"
83+
"your-atlas-service-accounts-client-secret"
8484
]
8585
}
8686
}
@@ -243,9 +243,9 @@ To learn more about Service Accounts, check the [MongoDB Atlas documentation](ht
243243
Set environment variables with the prefix `MDB_MCP_` followed by the option name in uppercase with underscores:
244244

245245
```shell
246-
# Set Atlas API credentials
247-
export MDB_MCP_API_CLIENT_ID="your-atlas-client-id"
248-
export MDB_MCP_API_CLIENT_SECRET="your-atlas-client-secret"
246+
# Set Atlas API credentials (via Service Accounts)
247+
export MDB_MCP_API_CLIENT_ID="your-atlas-service-accounts-client-id"
248+
export MDB_MCP_API_CLIENT_SECRET="your-atlas-service-accounts-client-secret"
249249

250250
# Set a custom MongoDB connection string
251251
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"
281281
"command": "npx",
282282
"args": ["-y", "mongodb-mcp-server"],
283283
"env": {
284-
"MDB_MCP_API_CLIENT_ID": "your-atlas-client-id",
285-
"MDB_MCP_API_CLIENT_SECRET": "your-atlas-client-secret"
284+
"MDB_MCP_API_CLIENT_ID": "your-atlas-service-accounts-client-id",
285+
"MDB_MCP_API_CLIENT_SECRET": "your-atlas-service-accounts-client-secret"
286286
}
287287
}
288288
}
@@ -294,7 +294,7 @@ export MDB_MCP_LOG_PATH="/path/to/logs"
294294
Pass configuration options as command-line arguments when starting the server:
295295

296296
```shell
297-
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
297+
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
298298
```
299299

300300
#### MCP configuration file examples
@@ -328,9 +328,9 @@ npx -y mongodb-mcp-server --apiClientId="your-atlas-client-id" --apiClientSecret
328328
"-y",
329329
"mongodb-mcp-server",
330330
"--apiClientId",
331-
"your-atlas-client-id",
331+
"your-atlas-service-accounts-client-id",
332332
"--apiClientSecret",
333-
"your-atlas-client-secret"
333+
"your-atlas-service-accounts-client-secret"
334334
]
335335
}
336336
}

0 commit comments

Comments
 (0)