Skip to content

Commit 9f80487

Browse files
committed
fix: README
1 parent 51da4ea commit 9f80487

File tree

2 files changed

+15
-14
lines changed

2 files changed

+15
-14
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -299,20 +299,20 @@ The MongoDB MCP Server can be configured using multiple methods, with the follow
299299

300300
### Configuration Options
301301

302-
| Option | Default | Description |
303-
| ------------------ | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
304-
| `apiClientId` | <not set> | Atlas API client ID for authentication. Required for running Atlas tools. |
305-
| `apiClientSecret` | <not set> | Atlas API client secret for authentication. Required for running Atlas tools. |
306-
| `connectionString` | <not set> | MongoDB connection string for direct database connections. Optional, if not set, you'll need to call the `connect` tool before interacting with MongoDB data. |
307-
| `loggers` | disk,mcp | Comma separated values, possible values are `mcp`, `disk` and `stderr`. See [Logger Options](#logger-options) for details. |
308-
| `logPath` | see note\* | Folder to store logs. |
309-
| `disabledTools` | <not set> | An array of tool names, operation types, and/or categories of tools that will be disabled. |
310-
| `readOnly` | false | When set to true, only allows read, connect, and metadata operation types, disabling create/update/delete operations. |
311-
| `indexCheck` | false | When set to true, enforces that query operations must use an index, rejecting queries that perform a collection scan. |
312-
| `telemetry` | enabled | When set to disabled, disables telemetry collection. |
313-
| `transport` | stdio | Either 'stdio' or 'http'. |
314-
| `httpPort` | 3000 | Port number. |
315-
| `httpHost` | 127.0.0.1 | Host to bind the http server. |
302+
| CLI Option | Environment Variable | Default | Description |
303+
| ------------------ | --------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
304+
| `apiClientId` | `MDB_MCP_API_CLIENT_ID` | <not set> | Atlas API client ID for authentication. Required for running Atlas tools. |
305+
| `apiClientSecret` | `MDB_MCP_API_CLIENT_SECRET` | <not set> | Atlas API client secret for authentication. Required for running Atlas tools. |
306+
| `connectionString` | `MDB_MCP_CONNECTION_STRING` | <not set> | MongoDB connection string for direct database connections. Optional, if not set, you'll need to call the `connect` tool before interacting with MongoDB data. |
307+
| `loggers` | `MDB_MCP_LOGGERS` | disk,mcp | Comma separated values, possible values are `mcp`, `disk` and `stderr`. See [Logger Options](#logger-options) for details. |
308+
| `logPath` | `MDB_MCP_LOG_PATH` | see note\* | Folder to store logs. |
309+
| `disabledTools` | `MDB_MCP_DISABLED_TOOLS` | <not set> | An array of tool names, operation types, and/or categories of tools that will be disabled. |
310+
| `readOnly` | `MDB_MCP_READ_ONLY` | false | When set to true, only allows read, connect, and metadata operation types, disabling create/update/delete operations. |
311+
| `indexCheck` | `MDB_MCP_INDEX_CHECK` | false | When set to true, enforces that query operations must use an index, rejecting queries that perform a collection scan. |
312+
| `telemetry` | `MDB_MCP_TELEMETRY` | enabled | When set to disabled, disables telemetry collection. |
313+
| `transport` | `MDB_MCP_TRANSPORT` | stdio | Either 'stdio' or 'http'. |
314+
| `httpPort` | `MDB_MCP_HTTP_PORT` | 3000 | Port number. |
315+
| `httpHost` | `MDB_MCP_HTTP_HOST` | 127.0.0.1 | Host to bind the http server. |
316316

317317
#### Logger Options
318318

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
},
1717
"type": "module",
1818
"scripts": {
19+
"start": "node dist/index.js --transport http",
1920
"prepare": "npm run build",
2021
"build:clean": "rm -rf dist",
2122
"build:compile": "tsc --project tsconfig.build.json",

0 commit comments

Comments
 (0)