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
@@ -305,6 +306,13 @@ NOTE: atlas tools are only available when you set credentials on [configuration]
305
306
-`collection-schema` - Describe the schema for a collection
306
307
-`collection-storage-size` - Get the size of a collection in MB
307
308
-`db-stats` - Return statistics about a MongoDB database
309
+
-`export` - Export query or aggregation results to EJSON format. Creates a uniquely named export accessible via the `exported-data` resource.
310
+
311
+
## 📄 Supported Resources
312
+
313
+
-`config` - Server configuration, supplied by the user either as environment variables or as startup arguments with sensitive parameters redacted. The resource can be accessed under URI `config://config`.
314
+
-`debug` - Debugging information for MongoDB connectivity issues. Tracks the last connectivity attempt and error information. The resource can be accessed under URI `debug://mongodb`.
315
+
-`exported-data` - A resource template to access the data exported using the export tool. The template can be accessed under URI `exported-data://{exportName}` where `exportName` is the unique name for an export generated by the export tool.
308
316
309
317
## Configuration
310
318
@@ -315,22 +323,25 @@ 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. |
321
-
|`apiClientSecret`|`MDB_MCP_API_CLIENT_SECRET`| <notset> | Atlas API client secret for authentication. Required for running Atlas tools. |
322
-
|`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. |
323
-
|`loggers`|`MDB_MCP_LOGGERS`| disk,mcp | Comma separated values, possible values are `mcp`, `disk` and `stderr`. See [Logger Options](#logger-options) for details. |
324
-
|`logPath`|`MDB_MCP_LOG_PATH`| see note\*| Folder to store logs. |
325
-
|`disabledTools`|`MDB_MCP_DISABLED_TOOLS`| <notset> | An array of tool names, operation types, and/or categories of tools that will be disabled. |
326
-
|`readOnly`|`MDB_MCP_READ_ONLY`| false | When set to true, only allows read, connect, and metadata operation types, disabling create/update/delete operations. |
327
-
|`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. |
328
-
|`telemetry`|`MDB_MCP_TELEMETRY`| enabled | When set to disabled, disables telemetry collection. |
329
-
|`transport`|`MDB_MCP_TRANSPORT`| stdio | Either 'stdio' or 'http'. |
330
-
|`httpPort`|`MDB_MCP_HTTP_PORT`| 3000 | Port number. |
331
-
|`httpHost`|`MDB_MCP_HTTP_HOST`| 127.0.0.1 | Host to bind the http server. |
332
-
|`idleTimeoutMs`|`MDB_MCP_IDLE_TIMEOUT_MS`| 600000 | Idle timeout for a client to disconnect (only applies to http transport). |
333
-
|`notificationTimeoutMs`|`MDB_MCP_NOTIFICATION_TIMEOUT_MS`| 540000 | Notification timeout for a client to be aware of diconnect (only applies to http transport). |
|`apiClientId`|`MDB_MCP_API_CLIENT_ID`| <notset> | Atlas API client ID for authentication. Required for running Atlas tools. |
329
+
|`apiClientSecret`|`MDB_MCP_API_CLIENT_SECRET`| <notset> | Atlas API client secret for authentication. Required for running Atlas tools. |
330
+
|`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. |
331
+
|`loggers`|`MDB_MCP_LOGGERS`| disk,mcp | Comma separated values, possible values are `mcp`, `disk` and `stderr`. See [Logger Options](#logger-options) for details. |
332
+
|`logPath`|`MDB_MCP_LOG_PATH`| see note\*| Folder to store logs. |
333
+
|`disabledTools`|`MDB_MCP_DISABLED_TOOLS`| <notset> | An array of tool names, operation types, and/or categories of tools that will be disabled. |
334
+
|`readOnly`|`MDB_MCP_READ_ONLY`| false | When set to true, only allows read, connect, and metadata operation types, disabling create/update/delete operations. |
335
+
|`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. |
336
+
|`telemetry`|`MDB_MCP_TELEMETRY`| enabled | When set to disabled, disables telemetry collection. |
337
+
|`transport`|`MDB_MCP_TRANSPORT`| stdio | Either 'stdio' or 'http'. |
338
+
|`httpPort`|`MDB_MCP_HTTP_PORT`| 3000 | Port number. |
339
+
|`httpHost`|`MDB_MCP_HTTP_HOST`| 127.0.0.1 | Host to bind the http server. |
340
+
|`idleTimeoutMs`|`MDB_MCP_IDLE_TIMEOUT_MS`| 600000 | Idle timeout for a client to disconnect (only applies to http transport). |
341
+
|`notificationTimeoutMs`|`MDB_MCP_NOTIFICATION_TIMEOUT_MS`| 540000 | Notification timeout for a client to be aware of diconnect (only applies to http transport). |
342
+
|`exportsPath`|`MDB_MCP_EXPORTS_PATH`| see note\*| Folder to store exported data files. |
343
+
|`exportTimeoutMs`|`MDB_MCP_EXPORT_TIMEOUT_MS`| 300000 | Time in milliseconds after which an export is considered expired and eligible for cleanup. |
344
+
|`exportCleanupIntervalMs`|`MDB_MCP_EXPORT_CLEANUP_INTERVAL_MS`| 120000 | Time in milliseconds between export cleanup cycles that remove expired export files. |
334
345
335
346
#### Logger Options
336
347
@@ -415,6 +426,17 @@ You can enable index check mode using:
415
426
416
427
When index check mode is active, you'll see an error message if a query is rejected due to not using an index.
417
428
429
+
#### Exports
430
+
431
+
The data exported by the `export` tool is temporarily stored in the configured `exportsPath` on the machine running the MCP server until cleaned up by the export cleanup process. If the `exportsPath` configuration is not provided, the following defaults are used:
The `exportTimeoutMs` configuration controls the time after which the exported data is considered expired and eligible for cleanup. By default, exports expire after 5 minutes (300000ms).
437
+
438
+
The `exportCleanupIntervalMs` configuration controls how frequently the cleanup process runs to remove expired export files. By default, cleanup runs every 2 minutes (120000ms).
439
+
418
440
#### Telemetry
419
441
420
442
The `telemetry` configuration option allows you to disable telemetry collection. When enabled, the MCP server will collect usage data and send it to MongoDB.
0 commit comments