You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+25-23Lines changed: 25 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -300,8 +300,8 @@ NOTE: atlas tools are only available when you set credentials on [configuration]
300
300
#### MongoDB Database Tools
301
301
302
302
-`connect` - Connect to a MongoDB instance
303
-
-`find` - Run a find query against a MongoDB collection
304
-
-`aggregate` - Run an aggregation against a MongoDB collection
303
+
-`find` - Run a find query against a MongoDB collection. The number of documents returned is limited by the `limit` parameter and the server's `maxDocumentsPerQuery` configuration, whichever is smaller. The total size of the returned documents is also limited by the `responseBytesLimit` parameter and the server's `maxBytesPerQuery` configuration, whichever is smaller.
304
+
-`aggregate` - Run an aggregation against a MongoDB collection. The number of documents returned is limited by the server's `maxDocumentsPerQuery` configuration. The total size of the returned documents is also limited by the `responseBytesLimit` parameter and the server's `maxBytesPerQuery` configuration, whichever is smaller.
305
305
-`count` - Get the number of documents in a MongoDB collection
306
306
-`insert-one` - Insert a single document into a MongoDB collection
307
307
-`insert-many` - Insert multiple documents into a MongoDB collection
@@ -338,27 +338,29 @@ The MongoDB MCP Server can be configured using multiple methods, with the follow
|`apiClientId`|`MDB_MCP_API_CLIENT_ID`| <notset> | Atlas API client ID for authentication. Required for running Atlas tools. |
344
-
|`apiClientSecret`|`MDB_MCP_API_CLIENT_SECRET`| <notset> | Atlas API client secret for authentication. Required for running Atlas tools. |
345
-
|`connectionString`|`MDB_MCP_CONNECTION_STRING`| <notset> | MongoDB connection string for direct database connections. Optional, if not set, you'll need to call the `connect` tool before interacting with MongoDB data. |
346
-
|`loggers`|`MDB_MCP_LOGGERS`| disk,mcp | Comma separated values, possible values are `mcp`, `disk` and `stderr`. See [Logger Options](#logger-options) for details. |
347
-
|`logPath`|`MDB_MCP_LOG_PATH`| see note\*| Folder to store logs. |
348
-
|`disabledTools`|`MDB_MCP_DISABLED_TOOLS`| <notset> | An array of tool names, operation types, and/or categories of tools that will be disabled. |
349
-
|`confirmationRequiredTools`|`MDB_MCP_CONFIRMATION_REQUIRED_TOOLS`| create-access-list,create-db-user,drop-database,drop-collection,delete-many | An array of tool names that require user confirmation before execution. **Requires the client to support [elicitation](https://modelcontextprotocol.io/specification/draft/client/elicitation)**. |
350
-
|`readOnly`|`MDB_MCP_READ_ONLY`| false | When set to true, only allows read, connect, and metadata operation types, disabling create/update/delete operations. |
351
-
|`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. |
352
-
|`telemetry`|`MDB_MCP_TELEMETRY`| enabled | When set to disabled, disables telemetry collection. |
353
-
|`transport`|`MDB_MCP_TRANSPORT`| stdio | Either 'stdio' or 'http'. |
354
-
|`httpPort`|`MDB_MCP_HTTP_PORT`| 3000 | Port number. |
355
-
|`httpHost`|`MDB_MCP_HTTP_HOST`| 127.0.0.1 | Host to bind the http server. |
356
-
|`idleTimeoutMs`|`MDB_MCP_IDLE_TIMEOUT_MS`| 600000 | Idle timeout for a client to disconnect (only applies to http transport). |
357
-
|`notificationTimeoutMs`|`MDB_MCP_NOTIFICATION_TIMEOUT_MS`| 540000 | Notification timeout for a client to be aware of diconnect (only applies to http transport). |
358
-
|`exportsPath`|`MDB_MCP_EXPORTS_PATH`| see note\*| Folder to store exported data files. |
359
-
|`exportTimeoutMs`|`MDB_MCP_EXPORT_TIMEOUT_MS`| 300000 | Time in milliseconds after which an export is considered expired and eligible for cleanup. |
360
-
|`exportCleanupIntervalMs`|`MDB_MCP_EXPORT_CLEANUP_INTERVAL_MS`| 120000 | Time in milliseconds between export cleanup cycles that remove expired export files. |
361
-
|`atlasTemporaryDatabaseUserLifetimeMs`|`MDB_MCP_ATLAS_TEMPORARY_DATABASE_USER_LIFETIME_MS`| 14400000 | Time in milliseconds that temporary database users created when connecting to MongoDB Atlas clusters will remain active before being automatically deleted. |
|`apiClientId`|`MDB_MCP_API_CLIENT_ID`| <notset> | Atlas API client ID for authentication. Required for running Atlas tools. |
344
+
|`apiClientSecret`|`MDB_MCP_API_CLIENT_SECRET`| <notset> | Atlas API client secret for authentication. Required for running Atlas tools. |
345
+
|`connectionString`|`MDB_MCP_CONNECTION_STRING`| <notset> | MongoDB connection string for direct database connections. Optional, if not set, you'll need to call the `connect` tool before interacting with MongoDB data. |
346
+
|`loggers`|`MDB_MCP_LOGGERS`| disk,mcp | Comma separated values, possible values are `mcp`, `disk` and `stderr`. See [Logger Options](#logger-options) for details. |
347
+
|`logPath`|`MDB_MCP_LOG_PATH`| see note\*| Folder to store logs. |
348
+
|`disabledTools`|`MDB_MCP_DISABLED_TOOLS`| <notset> | An array of tool names, operation types, and/or categories of tools that will be disabled. |
349
+
|`confirmationRequiredTools`|`MDB_MCP_CONFIRMATION_REQUIRED_TOOLS`| create-access-list,create-db-user,drop-database,drop-collection,delete-many | An array of tool names that require user confirmation before execution. **Requires the client to support [elicitation](https://modelcontextprotocol.io/specification/draft/client/elicitation)**. |
350
+
|`readOnly`|`MDB_MCP_READ_ONLY`| false | When set to true, only allows read, connect, and metadata operation types, disabling create/update/delete operations. |
351
+
|`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. |
352
+
|`telemetry`|`MDB_MCP_TELEMETRY`| enabled | When set to disabled, disables telemetry collection. |
353
+
|`transport`|`MDB_MCP_TRANSPORT`| stdio | Either 'stdio' or 'http'. |
354
+
|`httpPort`|`MDB_MCP_HTTP_PORT`| 3000 | Port number. |
355
+
|`httpHost`|`MDB_MCP_HTTP_HOST`| 127.0.0.1 | Host to bind the http server. |
356
+
|`idleTimeoutMs`|`MDB_MCP_IDLE_TIMEOUT_MS`| 600000 | Idle timeout for a client to disconnect (only applies to http transport). |
357
+
|`maxBytesPerQuery`|`MDB_MCP_MAX_BYTES_PER_QUERY`| 16777216 (16MiB) | The maximum size in bytes for results from a `find` or `aggregate` tool call. This serves as an upper bound for the `responseBytesLimit` parameter in those tools. |
358
+
|`maxDocumentsPerQuery`|`MDB_MCP_MAX_DOCUMENTS_PER_QUERY`| 100 | The maximum number of documents that can be returned by a `find` or `aggregate` tool call. For the `find` tool, the effective limit will be the smaller of this value and the tool's `limit` parameter. |
359
+
|`notificationTimeoutMs`|`MDB_MCP_NOTIFICATION_TIMEOUT_MS`| 540000 | Notification timeout for a client to be aware of diconnect (only applies to http transport). |
360
+
|`exportsPath`|`MDB_MCP_EXPORTS_PATH`| see note\*| Folder to store exported data files. |
361
+
|`exportTimeoutMs`|`MDB_MCP_EXPORT_TIMEOUT_MS`| 300000 | Time in milliseconds after which an export is considered expired and eligible for cleanup. |
362
+
|`exportCleanupIntervalMs`|`MDB_MCP_EXPORT_CLEANUP_INTERVAL_MS`| 120000 | Time in milliseconds between export cleanup cycles that remove expired export files. |
363
+
|`atlasTemporaryDatabaseUserLifetimeMs`|`MDB_MCP_ATLAS_TEMPORARY_DATABASE_USER_LIFETIME_MS`| 14400000 | Time in milliseconds that temporary database users created when connecting to MongoDB Atlas clusters will remain active before being automatically deleted. |
0 commit comments