mongodb-mcp-server 1.1.0 → 1.3.0-pre.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +64 -28
- package/dist/cjs/common/atlas/accessListUtils.js +1 -1
- package/dist/cjs/common/atlas/accessListUtils.js.map +1 -1
- package/dist/cjs/common/atlas/apiClient.d.ts +30 -26
- package/dist/cjs/common/atlas/apiClient.d.ts.map +1 -1
- package/dist/cjs/common/atlas/apiClient.js +12 -12
- package/dist/cjs/common/atlas/apiClient.js.map +1 -1
- package/dist/cjs/common/atlas/cluster.d.ts +7 -2
- package/dist/cjs/common/atlas/cluster.d.ts.map +1 -1
- package/dist/cjs/common/atlas/cluster.js +18 -4
- package/dist/cjs/common/atlas/cluster.js.map +1 -1
- package/dist/cjs/common/atlas/performanceAdvisorUtils.js +2 -2
- package/dist/cjs/common/atlas/performanceAdvisorUtils.js.map +1 -1
- package/dist/cjs/common/atlas/roles.d.ts +1 -1
- package/dist/cjs/common/atlas/roles.d.ts.map +1 -1
- package/dist/cjs/common/atlasLocal.d.ts +4 -0
- package/dist/cjs/common/atlasLocal.d.ts.map +1 -0
- package/dist/cjs/common/atlasLocal.js +57 -0
- package/dist/cjs/common/atlasLocal.js.map +1 -0
- package/dist/cjs/common/config/argsParserOptions.d.ts +12 -0
- package/dist/cjs/common/config/argsParserOptions.d.ts.map +1 -0
- package/dist/cjs/common/config/argsParserOptions.js +103 -0
- package/dist/cjs/common/config/argsParserOptions.js.map +1 -0
- package/dist/cjs/common/config/configOverrides.d.ts +30 -0
- package/dist/cjs/common/config/configOverrides.d.ts.map +1 -0
- package/dist/cjs/common/config/configOverrides.js +145 -0
- package/dist/cjs/common/config/configOverrides.js.map +1 -0
- package/dist/cjs/common/config/configUtils.d.ts +43 -0
- package/dist/cjs/common/config/configUtils.d.ts.map +1 -0
- package/dist/cjs/common/config/configUtils.js +178 -0
- package/dist/cjs/common/config/configUtils.js.map +1 -0
- package/dist/cjs/common/config/createUserConfig.d.ts +10 -0
- package/dist/cjs/common/config/createUserConfig.d.ts.map +1 -0
- package/dist/cjs/common/config/createUserConfig.js +156 -0
- package/dist/cjs/common/config/createUserConfig.js.map +1 -0
- package/dist/cjs/common/config/userConfig.d.ts +54 -0
- package/dist/cjs/common/config/userConfig.d.ts.map +1 -0
- package/dist/cjs/common/config/userConfig.js +180 -0
- package/dist/cjs/common/config/userConfig.js.map +1 -0
- package/dist/cjs/common/connectionErrorHandler.d.ts.map +1 -1
- package/dist/cjs/common/connectionErrorHandler.js +15 -6
- package/dist/cjs/common/connectionErrorHandler.js.map +1 -1
- package/dist/cjs/common/connectionManager.d.ts +6 -5
- package/dist/cjs/common/connectionManager.d.ts.map +1 -1
- package/dist/cjs/common/connectionManager.js +29 -19
- package/dist/cjs/common/connectionManager.js.map +1 -1
- package/dist/cjs/common/errors.d.ts +6 -1
- package/dist/cjs/common/errors.d.ts.map +1 -1
- package/dist/cjs/common/errors.js +5 -0
- package/dist/cjs/common/errors.js.map +1 -1
- package/dist/cjs/common/exportsManager.d.ts +1 -1
- package/dist/cjs/common/exportsManager.d.ts.map +1 -1
- package/dist/cjs/common/logger.d.ts +2 -0
- package/dist/cjs/common/logger.d.ts.map +1 -1
- package/dist/cjs/common/logger.js +2 -0
- package/dist/cjs/common/logger.js.map +1 -1
- package/dist/cjs/common/packageInfo.js +1 -1
- package/dist/cjs/common/packageInfo.js.map +1 -1
- package/dist/cjs/common/schemas.d.ts +5 -0
- package/dist/cjs/common/schemas.d.ts.map +1 -0
- package/dist/cjs/common/schemas.js +6 -0
- package/dist/cjs/common/schemas.js.map +1 -0
- package/dist/cjs/common/search/embeddingsProvider.d.ts +10 -0
- package/dist/cjs/common/search/embeddingsProvider.d.ts.map +1 -0
- package/dist/cjs/common/search/embeddingsProvider.js +45 -0
- package/dist/cjs/common/search/embeddingsProvider.js.map +1 -0
- package/dist/cjs/common/search/vectorSearchEmbeddingsManager.d.ts +67 -0
- package/dist/cjs/common/search/vectorSearchEmbeddingsManager.d.ts.map +1 -0
- package/dist/cjs/common/search/vectorSearchEmbeddingsManager.js +188 -0
- package/dist/cjs/common/search/vectorSearchEmbeddingsManager.js.map +1 -0
- package/dist/cjs/common/session.d.ts +14 -5
- package/dist/cjs/common/session.d.ts.map +1 -1
- package/dist/cjs/common/session.js +28 -8
- package/dist/cjs/common/session.js.map +1 -1
- package/dist/cjs/helpers/assertVectorSearchFilterFieldsAreIndexed.d.ts +27 -0
- package/dist/cjs/helpers/assertVectorSearchFilterFieldsAreIndexed.d.ts.map +1 -0
- package/dist/cjs/helpers/assertVectorSearchFilterFieldsAreIndexed.js +58 -0
- package/dist/cjs/helpers/assertVectorSearchFilterFieldsAreIndexed.js.map +1 -0
- package/dist/cjs/index.d.ts +2 -1
- package/dist/cjs/index.d.ts.map +1 -1
- package/dist/cjs/index.js +44 -16
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/lib.d.ts +6 -2
- package/dist/cjs/lib.d.ts.map +1 -1
- package/dist/cjs/lib.js +10 -4
- package/dist/cjs/lib.js.map +1 -1
- package/dist/cjs/resources/common/config.d.ts +1 -1
- package/dist/cjs/resources/common/config.d.ts.map +1 -1
- package/dist/cjs/resources/common/config.js +4 -3
- package/dist/cjs/resources/common/config.js.map +1 -1
- package/dist/cjs/resources/resource.d.ts +1 -1
- package/dist/cjs/resources/resource.d.ts.map +1 -1
- package/dist/cjs/server.d.ts +26 -5
- package/dist/cjs/server.d.ts.map +1 -1
- package/dist/cjs/server.js +7 -23
- package/dist/cjs/server.js.map +1 -1
- package/dist/cjs/telemetry/telemetry.d.ts +1 -1
- package/dist/cjs/telemetry/telemetry.d.ts.map +1 -1
- package/dist/cjs/telemetry/types.d.ts +22 -4
- package/dist/cjs/telemetry/types.d.ts.map +1 -1
- package/dist/cjs/tools/args.d.ts +1 -0
- package/dist/cjs/tools/args.d.ts.map +1 -1
- package/dist/cjs/tools/args.js +1 -0
- package/dist/cjs/tools/args.js.map +1 -1
- package/dist/cjs/tools/atlas/atlasTool.d.ts +3 -2
- package/dist/cjs/tools/atlas/atlasTool.d.ts.map +1 -1
- package/dist/cjs/tools/atlas/atlasTool.js +3 -3
- package/dist/cjs/tools/atlas/atlasTool.js.map +1 -1
- package/dist/cjs/tools/atlas/connect/connectCluster.d.ts +6 -1
- package/dist/cjs/tools/atlas/connect/connectCluster.d.ts.map +1 -1
- package/dist/cjs/tools/atlas/connect/connectCluster.js +46 -21
- package/dist/cjs/tools/atlas/connect/connectCluster.js.map +1 -1
- package/dist/cjs/tools/atlas/create/createAccessList.js +1 -1
- package/dist/cjs/tools/atlas/create/createAccessList.js.map +1 -1
- package/dist/cjs/tools/atlas/create/createProject.d.ts +0 -4
- package/dist/cjs/tools/atlas/create/createProject.d.ts.map +1 -1
- package/dist/cjs/tools/atlas/create/createProject.js +5 -8
- package/dist/cjs/tools/atlas/create/createProject.js.map +1 -1
- package/dist/cjs/tools/atlas/read/getPerformanceAdvisor.d.ts +4 -1
- package/dist/cjs/tools/atlas/read/getPerformanceAdvisor.d.ts.map +1 -1
- package/dist/cjs/tools/atlas/read/getPerformanceAdvisor.js +7 -1
- package/dist/cjs/tools/atlas/read/getPerformanceAdvisor.js.map +1 -1
- package/dist/cjs/tools/atlas/read/inspectAccessList.d.ts.map +1 -1
- package/dist/cjs/tools/atlas/read/inspectAccessList.js +7 -8
- package/dist/cjs/tools/atlas/read/inspectAccessList.js.map +1 -1
- package/dist/cjs/tools/atlas/read/inspectCluster.d.ts.map +1 -1
- package/dist/cjs/tools/atlas/read/inspectCluster.js +9 -3
- package/dist/cjs/tools/atlas/read/inspectCluster.js.map +1 -1
- package/dist/cjs/tools/atlas/read/listAlerts.d.ts.map +1 -1
- package/dist/cjs/tools/atlas/read/listAlerts.js +9 -13
- package/dist/cjs/tools/atlas/read/listAlerts.js.map +1 -1
- package/dist/cjs/tools/atlas/read/listClusters.d.ts.map +1 -1
- package/dist/cjs/tools/atlas/read/listClusters.js +9 -25
- package/dist/cjs/tools/atlas/read/listClusters.js.map +1 -1
- package/dist/cjs/tools/atlas/read/listDBUsers.d.ts.map +1 -1
- package/dist/cjs/tools/atlas/read/listDBUsers.js +13 -23
- package/dist/cjs/tools/atlas/read/listDBUsers.js.map +1 -1
- package/dist/cjs/tools/atlas/read/listOrgs.d.ts.map +1 -1
- package/dist/cjs/tools/atlas/read/listOrgs.js +6 -11
- package/dist/cjs/tools/atlas/read/listOrgs.js.map +1 -1
- package/dist/cjs/tools/atlas/read/listProjects.d.ts +0 -3
- package/dist/cjs/tools/atlas/read/listProjects.d.ts.map +1 -1
- package/dist/cjs/tools/atlas/read/listProjects.js +18 -23
- package/dist/cjs/tools/atlas/read/listProjects.js.map +1 -1
- package/dist/cjs/tools/atlasLocal/atlasLocalTool.d.ts +20 -0
- package/dist/cjs/tools/atlasLocal/atlasLocalTool.d.ts.map +1 -0
- package/dist/cjs/tools/atlasLocal/atlasLocalTool.js +109 -0
- package/dist/cjs/tools/atlasLocal/atlasLocalTool.js.map +1 -0
- package/dist/cjs/tools/atlasLocal/connect/connectDeployment.d.ts +16 -0
- package/dist/cjs/tools/atlasLocal/connect/connectDeployment.d.ts.map +1 -0
- package/dist/cjs/tools/atlasLocal/connect/connectDeployment.js +38 -0
- package/dist/cjs/tools/atlasLocal/connect/connectDeployment.js.map +1 -0
- package/dist/cjs/tools/atlasLocal/create/createDeployment.d.ts +14 -0
- package/dist/cjs/tools/atlasLocal/create/createDeployment.d.ts.map +1 -0
- package/dist/cjs/tools/atlasLocal/create/createDeployment.js +41 -0
- package/dist/cjs/tools/atlasLocal/create/createDeployment.js.map +1 -0
- package/dist/cjs/tools/atlasLocal/delete/deleteDeployment.d.ts +14 -0
- package/dist/cjs/tools/atlasLocal/delete/deleteDeployment.d.ts.map +1 -0
- package/dist/cjs/tools/atlasLocal/delete/deleteDeployment.js +32 -0
- package/dist/cjs/tools/atlasLocal/delete/deleteDeployment.js.map +1 -0
- package/dist/cjs/tools/atlasLocal/read/listDeployments.d.ts +13 -0
- package/dist/cjs/tools/atlasLocal/read/listDeployments.d.ts.map +1 -0
- package/dist/cjs/tools/atlasLocal/read/listDeployments.js +42 -0
- package/dist/cjs/tools/atlasLocal/read/listDeployments.js.map +1 -0
- package/dist/cjs/tools/atlasLocal/tools.d.ts +6 -0
- package/dist/cjs/tools/atlasLocal/tools.d.ts.map +1 -0
- package/dist/cjs/tools/atlasLocal/tools.js +9 -0
- package/dist/cjs/tools/atlasLocal/tools.js.map +1 -0
- package/dist/cjs/tools/index.d.ts +7 -0
- package/dist/cjs/tools/index.d.ts.map +1 -0
- package/dist/cjs/tools/index.js +14 -0
- package/dist/cjs/tools/index.js.map +1 -0
- package/dist/cjs/tools/mongodb/connect/connect.d.ts +4 -10
- package/dist/cjs/tools/mongodb/connect/connect.d.ts.map +1 -1
- package/dist/cjs/tools/mongodb/connect/connect.js +17 -70
- package/dist/cjs/tools/mongodb/connect/connect.js.map +1 -1
- package/dist/cjs/tools/mongodb/connect/switchConnection.d.ts +17 -0
- package/dist/cjs/tools/mongodb/connect/switchConnection.d.ts.map +1 -0
- package/dist/cjs/tools/mongodb/connect/switchConnection.js +52 -0
- package/dist/cjs/tools/mongodb/connect/switchConnection.js.map +1 -0
- package/dist/cjs/tools/mongodb/create/createIndex.d.ts +1 -1
- package/dist/cjs/tools/mongodb/create/createIndex.d.ts.map +1 -1
- package/dist/cjs/tools/mongodb/create/createIndex.js +9 -22
- package/dist/cjs/tools/mongodb/create/createIndex.js.map +1 -1
- package/dist/cjs/tools/mongodb/create/insertMany.d.ts +22 -2
- package/dist/cjs/tools/mongodb/create/insertMany.d.ts.map +1 -1
- package/dist/cjs/tools/mongodb/create/insertMany.js +88 -12
- package/dist/cjs/tools/mongodb/create/insertMany.js.map +1 -1
- package/dist/cjs/tools/mongodb/delete/dropIndex.d.ts +5 -2
- package/dist/cjs/tools/mongodb/delete/dropIndex.d.ts.map +1 -1
- package/dist/cjs/tools/mongodb/delete/dropIndex.js +36 -3
- package/dist/cjs/tools/mongodb/delete/dropIndex.js.map +1 -1
- package/dist/cjs/tools/mongodb/metadata/collectionIndexes.d.ts +15 -0
- package/dist/cjs/tools/mongodb/metadata/collectionIndexes.d.ts.map +1 -1
- package/dist/cjs/tools/mongodb/metadata/collectionIndexes.js +30 -5
- package/dist/cjs/tools/mongodb/metadata/collectionIndexes.js.map +1 -1
- package/dist/cjs/tools/mongodb/metadata/collectionSchema.js +1 -1
- package/dist/cjs/tools/mongodb/metadata/explain.d.ts +192 -10
- package/dist/cjs/tools/mongodb/metadata/explain.d.ts.map +1 -1
- package/dist/cjs/tools/mongodb/metadata/explain.js +1 -1
- package/dist/cjs/tools/mongodb/metadata/explain.js.map +1 -1
- package/dist/cjs/tools/mongodb/metadata/listDatabases.d.ts.map +1 -1
- package/dist/cjs/tools/mongodb/metadata/listDatabases.js +1 -3
- package/dist/cjs/tools/mongodb/metadata/listDatabases.js.map +1 -1
- package/dist/cjs/tools/mongodb/mongodbSchemas.d.ts +155 -0
- package/dist/cjs/tools/mongodb/mongodbSchemas.d.ts.map +1 -0
- package/dist/cjs/tools/mongodb/mongodbSchemas.js +69 -0
- package/dist/cjs/tools/mongodb/mongodbSchemas.js.map +1 -0
- package/dist/cjs/tools/mongodb/mongodbTool.d.ts +14 -3
- package/dist/cjs/tools/mongodb/mongodbTool.d.ts.map +1 -1
- package/dist/cjs/tools/mongodb/mongodbTool.js +31 -11
- package/dist/cjs/tools/mongodb/mongodbTool.js.map +1 -1
- package/dist/cjs/tools/mongodb/read/aggregate.d.ts +218 -4
- package/dist/cjs/tools/mongodb/read/aggregate.d.ts.map +1 -1
- package/dist/cjs/tools/mongodb/read/aggregate.js +125 -18
- package/dist/cjs/tools/mongodb/read/aggregate.js.map +1 -1
- package/dist/cjs/tools/mongodb/read/export.d.ts +192 -10
- package/dist/cjs/tools/mongodb/read/export.d.ts.map +1 -1
- package/dist/cjs/tools/mongodb/read/export.js +3 -1
- package/dist/cjs/tools/mongodb/read/export.js.map +1 -1
- package/dist/cjs/tools/mongodb/read/find.js +2 -2
- package/dist/cjs/tools/mongodb/read/find.js.map +1 -1
- package/dist/cjs/tools/mongodb/tools.d.ts +2 -2
- package/dist/cjs/tools/mongodb/tools.d.ts.map +1 -1
- package/dist/cjs/tools/mongodb/tools.js +2 -2
- package/dist/cjs/tools/mongodb/tools.js.map +1 -1
- package/dist/cjs/tools/tool.d.ts +14 -24
- package/dist/cjs/tools/tool.d.ts.map +1 -1
- package/dist/cjs/tools/tool.js +44 -54
- package/dist/cjs/tools/tool.js.map +1 -1
- package/dist/cjs/transports/base.d.ts +25 -3
- package/dist/cjs/transports/base.d.ts.map +1 -1
- package/dist/cjs/transports/base.js +41 -10
- package/dist/cjs/transports/base.js.map +1 -1
- package/dist/cjs/transports/dryModeRunner.d.ts +19 -0
- package/dist/cjs/transports/dryModeRunner.d.ts.map +1 -0
- package/dist/cjs/transports/dryModeRunner.js +37 -0
- package/dist/cjs/transports/dryModeRunner.js.map +1 -0
- package/dist/cjs/transports/inMemoryTransport.d.ts +18 -0
- package/dist/cjs/transports/inMemoryTransport.d.ts.map +1 -0
- package/dist/cjs/transports/inMemoryTransport.js +43 -0
- package/dist/cjs/transports/inMemoryTransport.js.map +1 -0
- package/dist/cjs/transports/streamableHttp.d.ts.map +1 -1
- package/dist/cjs/transports/streamableHttp.js +5 -1
- package/dist/cjs/transports/streamableHttp.js.map +1 -1
- package/dist/esm/common/atlas/accessListUtils.js +1 -1
- package/dist/esm/common/atlas/accessListUtils.js.map +1 -1
- package/dist/esm/common/atlas/apiClient.d.ts +30 -26
- package/dist/esm/common/atlas/apiClient.d.ts.map +1 -1
- package/dist/esm/common/atlas/apiClient.js +12 -12
- package/dist/esm/common/atlas/apiClient.js.map +1 -1
- package/dist/esm/common/atlas/cluster.d.ts +7 -2
- package/dist/esm/common/atlas/cluster.d.ts.map +1 -1
- package/dist/esm/common/atlas/cluster.js +17 -4
- package/dist/esm/common/atlas/cluster.js.map +1 -1
- package/dist/esm/common/atlas/performanceAdvisorUtils.js +2 -2
- package/dist/esm/common/atlas/performanceAdvisorUtils.js.map +1 -1
- package/dist/esm/common/atlas/roles.d.ts +1 -1
- package/dist/esm/common/atlas/roles.d.ts.map +1 -1
- package/dist/esm/common/atlasLocal.d.ts +4 -0
- package/dist/esm/common/atlasLocal.d.ts.map +1 -0
- package/dist/esm/common/atlasLocal.js +20 -0
- package/dist/esm/common/atlasLocal.js.map +1 -0
- package/dist/esm/common/config/argsParserOptions.d.ts +12 -0
- package/dist/esm/common/config/argsParserOptions.d.ts.map +1 -0
- package/dist/esm/common/config/argsParserOptions.js +100 -0
- package/dist/esm/common/config/argsParserOptions.js.map +1 -0
- package/dist/esm/common/config/configOverrides.d.ts +30 -0
- package/dist/esm/common/config/configOverrides.d.ts.map +1 -0
- package/dist/esm/common/config/configOverrides.js +139 -0
- package/dist/esm/common/config/configOverrides.js.map +1 -0
- package/dist/esm/common/config/configUtils.d.ts +43 -0
- package/dist/esm/common/config/configUtils.d.ts.map +1 -0
- package/dist/esm/common/config/configUtils.js +130 -0
- package/dist/esm/common/config/configUtils.js.map +1 -0
- package/dist/esm/common/config/createUserConfig.d.ts +10 -0
- package/dist/esm/common/config/createUserConfig.d.ts.map +1 -0
- package/dist/esm/common/config/createUserConfig.js +149 -0
- package/dist/esm/common/config/createUserConfig.js.map +1 -0
- package/dist/esm/common/config/userConfig.d.ts +54 -0
- package/dist/esm/common/config/userConfig.d.ts.map +1 -0
- package/dist/esm/common/config/userConfig.js +177 -0
- package/dist/esm/common/config/userConfig.js.map +1 -0
- package/dist/esm/common/connectionErrorHandler.d.ts.map +1 -1
- package/dist/esm/common/connectionErrorHandler.js +15 -6
- package/dist/esm/common/connectionErrorHandler.js.map +1 -1
- package/dist/esm/common/connectionManager.d.ts +6 -5
- package/dist/esm/common/connectionManager.d.ts.map +1 -1
- package/dist/esm/common/connectionManager.js +28 -18
- package/dist/esm/common/connectionManager.js.map +1 -1
- package/dist/esm/common/errors.d.ts +6 -1
- package/dist/esm/common/errors.d.ts.map +1 -1
- package/dist/esm/common/errors.js +5 -0
- package/dist/esm/common/errors.js.map +1 -1
- package/dist/esm/common/exportsManager.d.ts +1 -1
- package/dist/esm/common/exportsManager.d.ts.map +1 -1
- package/dist/esm/common/logger.d.ts +2 -0
- package/dist/esm/common/logger.d.ts.map +1 -1
- package/dist/esm/common/logger.js +2 -0
- package/dist/esm/common/logger.js.map +1 -1
- package/dist/esm/common/packageInfo.js +1 -1
- package/dist/esm/common/packageInfo.js.map +1 -1
- package/dist/esm/common/schemas.d.ts +5 -0
- package/dist/esm/common/schemas.d.ts.map +1 -0
- package/dist/esm/common/schemas.js +3 -0
- package/dist/esm/common/schemas.js.map +1 -0
- package/dist/esm/common/search/embeddingsProvider.d.ts +10 -0
- package/dist/esm/common/search/embeddingsProvider.d.ts.map +1 -0
- package/dist/esm/common/search/embeddingsProvider.js +39 -0
- package/dist/esm/common/search/embeddingsProvider.js.map +1 -0
- package/dist/esm/common/search/vectorSearchEmbeddingsManager.d.ts +67 -0
- package/dist/esm/common/search/vectorSearchEmbeddingsManager.d.ts.map +1 -0
- package/dist/esm/common/search/vectorSearchEmbeddingsManager.js +181 -0
- package/dist/esm/common/search/vectorSearchEmbeddingsManager.js.map +1 -0
- package/dist/esm/common/session.d.ts +14 -5
- package/dist/esm/common/session.d.ts.map +1 -1
- package/dist/esm/common/session.js +28 -8
- package/dist/esm/common/session.js.map +1 -1
- package/dist/esm/helpers/assertVectorSearchFilterFieldsAreIndexed.d.ts +27 -0
- package/dist/esm/helpers/assertVectorSearchFilterFieldsAreIndexed.d.ts.map +1 -0
- package/dist/esm/helpers/assertVectorSearchFilterFieldsAreIndexed.js +54 -0
- package/dist/esm/helpers/assertVectorSearchFilterFieldsAreIndexed.js.map +1 -0
- package/dist/esm/index.d.ts +2 -1
- package/dist/esm/index.d.ts.map +1 -1
- package/dist/esm/index.js +40 -13
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/lib.d.ts +6 -2
- package/dist/esm/lib.d.ts.map +1 -1
- package/dist/esm/lib.js +5 -2
- package/dist/esm/lib.js.map +1 -1
- package/dist/esm/resources/common/config.d.ts +1 -1
- package/dist/esm/resources/common/config.d.ts.map +1 -1
- package/dist/esm/resources/common/config.js +4 -3
- package/dist/esm/resources/common/config.js.map +1 -1
- package/dist/esm/resources/resource.d.ts +1 -1
- package/dist/esm/resources/resource.d.ts.map +1 -1
- package/dist/esm/server.d.ts +26 -5
- package/dist/esm/server.d.ts.map +1 -1
- package/dist/esm/server.js +7 -23
- package/dist/esm/server.js.map +1 -1
- package/dist/esm/telemetry/telemetry.d.ts +1 -1
- package/dist/esm/telemetry/telemetry.d.ts.map +1 -1
- package/dist/esm/telemetry/types.d.ts +22 -4
- package/dist/esm/telemetry/types.d.ts.map +1 -1
- package/dist/esm/tools/args.d.ts +1 -0
- package/dist/esm/tools/args.d.ts.map +1 -1
- package/dist/esm/tools/args.js +1 -0
- package/dist/esm/tools/args.js.map +1 -1
- package/dist/esm/tools/atlas/atlasTool.d.ts +3 -2
- package/dist/esm/tools/atlas/atlasTool.d.ts.map +1 -1
- package/dist/esm/tools/atlas/atlasTool.js +3 -3
- package/dist/esm/tools/atlas/atlasTool.js.map +1 -1
- package/dist/esm/tools/atlas/connect/connectCluster.d.ts +6 -1
- package/dist/esm/tools/atlas/connect/connectCluster.d.ts.map +1 -1
- package/dist/esm/tools/atlas/connect/connectCluster.js +47 -22
- package/dist/esm/tools/atlas/connect/connectCluster.js.map +1 -1
- package/dist/esm/tools/atlas/create/createAccessList.js +1 -1
- package/dist/esm/tools/atlas/create/createAccessList.js.map +1 -1
- package/dist/esm/tools/atlas/create/createProject.d.ts +0 -4
- package/dist/esm/tools/atlas/create/createProject.d.ts.map +1 -1
- package/dist/esm/tools/atlas/create/createProject.js +4 -7
- package/dist/esm/tools/atlas/create/createProject.js.map +1 -1
- package/dist/esm/tools/atlas/read/getPerformanceAdvisor.d.ts +4 -1
- package/dist/esm/tools/atlas/read/getPerformanceAdvisor.d.ts.map +1 -1
- package/dist/esm/tools/atlas/read/getPerformanceAdvisor.js +7 -1
- package/dist/esm/tools/atlas/read/getPerformanceAdvisor.js.map +1 -1
- package/dist/esm/tools/atlas/read/inspectAccessList.d.ts.map +1 -1
- package/dist/esm/tools/atlas/read/inspectAccessList.js +7 -8
- package/dist/esm/tools/atlas/read/inspectAccessList.js.map +1 -1
- package/dist/esm/tools/atlas/read/inspectCluster.d.ts.map +1 -1
- package/dist/esm/tools/atlas/read/inspectCluster.js +9 -3
- package/dist/esm/tools/atlas/read/inspectCluster.js.map +1 -1
- package/dist/esm/tools/atlas/read/listAlerts.d.ts.map +1 -1
- package/dist/esm/tools/atlas/read/listAlerts.js +9 -13
- package/dist/esm/tools/atlas/read/listAlerts.js.map +1 -1
- package/dist/esm/tools/atlas/read/listClusters.d.ts.map +1 -1
- package/dist/esm/tools/atlas/read/listClusters.js +9 -25
- package/dist/esm/tools/atlas/read/listClusters.js.map +1 -1
- package/dist/esm/tools/atlas/read/listDBUsers.d.ts.map +1 -1
- package/dist/esm/tools/atlas/read/listDBUsers.js +13 -23
- package/dist/esm/tools/atlas/read/listDBUsers.js.map +1 -1
- package/dist/esm/tools/atlas/read/listOrgs.d.ts.map +1 -1
- package/dist/esm/tools/atlas/read/listOrgs.js +6 -11
- package/dist/esm/tools/atlas/read/listOrgs.js.map +1 -1
- package/dist/esm/tools/atlas/read/listProjects.d.ts +0 -3
- package/dist/esm/tools/atlas/read/listProjects.d.ts.map +1 -1
- package/dist/esm/tools/atlas/read/listProjects.js +17 -22
- package/dist/esm/tools/atlas/read/listProjects.js.map +1 -1
- package/dist/esm/tools/atlasLocal/atlasLocalTool.d.ts +20 -0
- package/dist/esm/tools/atlasLocal/atlasLocalTool.d.ts.map +1 -0
- package/dist/esm/tools/atlasLocal/atlasLocalTool.js +105 -0
- package/dist/esm/tools/atlasLocal/atlasLocalTool.js.map +1 -0
- package/dist/esm/tools/atlasLocal/connect/connectDeployment.d.ts +16 -0
- package/dist/esm/tools/atlasLocal/connect/connectDeployment.d.ts.map +1 -0
- package/dist/esm/tools/atlasLocal/connect/connectDeployment.js +34 -0
- package/dist/esm/tools/atlasLocal/connect/connectDeployment.js.map +1 -0
- package/dist/esm/tools/atlasLocal/create/createDeployment.d.ts +14 -0
- package/dist/esm/tools/atlasLocal/create/createDeployment.d.ts.map +1 -0
- package/dist/esm/tools/atlasLocal/create/createDeployment.js +37 -0
- package/dist/esm/tools/atlasLocal/create/createDeployment.js.map +1 -0
- package/dist/esm/tools/atlasLocal/delete/deleteDeployment.d.ts +14 -0
- package/dist/esm/tools/atlasLocal/delete/deleteDeployment.d.ts.map +1 -0
- package/dist/esm/tools/atlasLocal/delete/deleteDeployment.js +28 -0
- package/dist/esm/tools/atlasLocal/delete/deleteDeployment.js.map +1 -0
- package/dist/esm/tools/atlasLocal/read/listDeployments.d.ts +13 -0
- package/dist/esm/tools/atlasLocal/read/listDeployments.d.ts.map +1 -0
- package/dist/esm/tools/atlasLocal/read/listDeployments.js +38 -0
- package/dist/esm/tools/atlasLocal/read/listDeployments.js.map +1 -0
- package/dist/esm/tools/atlasLocal/tools.d.ts +6 -0
- package/dist/esm/tools/atlasLocal/tools.d.ts.map +1 -0
- package/dist/esm/tools/atlasLocal/tools.js +6 -0
- package/dist/esm/tools/atlasLocal/tools.js.map +1 -0
- package/dist/esm/tools/index.d.ts +7 -0
- package/dist/esm/tools/index.d.ts.map +1 -0
- package/dist/esm/tools/index.js +7 -0
- package/dist/esm/tools/index.js.map +1 -0
- package/dist/esm/tools/mongodb/connect/connect.d.ts +4 -10
- package/dist/esm/tools/mongodb/connect/connect.d.ts.map +1 -1
- package/dist/esm/tools/mongodb/connect/connect.js +17 -67
- package/dist/esm/tools/mongodb/connect/connect.js.map +1 -1
- package/dist/esm/tools/mongodb/connect/switchConnection.d.ts +17 -0
- package/dist/esm/tools/mongodb/connect/switchConnection.d.ts.map +1 -0
- package/dist/esm/tools/mongodb/connect/switchConnection.js +45 -0
- package/dist/esm/tools/mongodb/connect/switchConnection.js.map +1 -0
- package/dist/esm/tools/mongodb/create/createIndex.d.ts +1 -1
- package/dist/esm/tools/mongodb/create/createIndex.d.ts.map +1 -1
- package/dist/esm/tools/mongodb/create/createIndex.js +9 -22
- package/dist/esm/tools/mongodb/create/createIndex.js.map +1 -1
- package/dist/esm/tools/mongodb/create/insertMany.d.ts +22 -2
- package/dist/esm/tools/mongodb/create/insertMany.d.ts.map +1 -1
- package/dist/esm/tools/mongodb/create/insertMany.js +88 -12
- package/dist/esm/tools/mongodb/create/insertMany.js.map +1 -1
- package/dist/esm/tools/mongodb/delete/dropIndex.d.ts +5 -2
- package/dist/esm/tools/mongodb/delete/dropIndex.d.ts.map +1 -1
- package/dist/esm/tools/mongodb/delete/dropIndex.js +36 -3
- package/dist/esm/tools/mongodb/delete/dropIndex.js.map +1 -1
- package/dist/esm/tools/mongodb/metadata/collectionIndexes.d.ts +15 -0
- package/dist/esm/tools/mongodb/metadata/collectionIndexes.d.ts.map +1 -1
- package/dist/esm/tools/mongodb/metadata/collectionIndexes.js +30 -5
- package/dist/esm/tools/mongodb/metadata/collectionIndexes.js.map +1 -1
- package/dist/esm/tools/mongodb/metadata/collectionSchema.js +1 -1
- package/dist/esm/tools/mongodb/metadata/explain.d.ts +192 -10
- package/dist/esm/tools/mongodb/metadata/explain.d.ts.map +1 -1
- package/dist/esm/tools/mongodb/metadata/explain.js +2 -2
- package/dist/esm/tools/mongodb/metadata/explain.js.map +1 -1
- package/dist/esm/tools/mongodb/metadata/listDatabases.d.ts.map +1 -1
- package/dist/esm/tools/mongodb/metadata/listDatabases.js +1 -3
- package/dist/esm/tools/mongodb/metadata/listDatabases.js.map +1 -1
- package/dist/esm/tools/mongodb/mongodbSchemas.d.ts +155 -0
- package/dist/esm/tools/mongodb/mongodbSchemas.d.ts.map +1 -0
- package/dist/esm/tools/mongodb/mongodbSchemas.js +63 -0
- package/dist/esm/tools/mongodb/mongodbSchemas.js.map +1 -0
- package/dist/esm/tools/mongodb/mongodbTool.d.ts +14 -3
- package/dist/esm/tools/mongodb/mongodbTool.d.ts.map +1 -1
- package/dist/esm/tools/mongodb/mongodbTool.js +31 -11
- package/dist/esm/tools/mongodb/mongodbTool.js.map +1 -1
- package/dist/esm/tools/mongodb/read/aggregate.d.ts +218 -4
- package/dist/esm/tools/mongodb/read/aggregate.d.ts.map +1 -1
- package/dist/esm/tools/mongodb/read/aggregate.js +123 -17
- package/dist/esm/tools/mongodb/read/aggregate.js.map +1 -1
- package/dist/esm/tools/mongodb/read/export.d.ts +192 -10
- package/dist/esm/tools/mongodb/read/export.d.ts.map +1 -1
- package/dist/esm/tools/mongodb/read/export.js +4 -2
- package/dist/esm/tools/mongodb/read/export.js.map +1 -1
- package/dist/esm/tools/mongodb/read/find.js +2 -2
- package/dist/esm/tools/mongodb/read/find.js.map +1 -1
- package/dist/esm/tools/mongodb/tools.d.ts +2 -2
- package/dist/esm/tools/mongodb/tools.d.ts.map +1 -1
- package/dist/esm/tools/mongodb/tools.js +2 -2
- package/dist/esm/tools/mongodb/tools.js.map +1 -1
- package/dist/esm/tools/tool.d.ts +14 -24
- package/dist/esm/tools/tool.d.ts.map +1 -1
- package/dist/esm/tools/tool.js +44 -54
- package/dist/esm/tools/tool.js.map +1 -1
- package/dist/esm/transports/base.d.ts +25 -3
- package/dist/esm/transports/base.d.ts.map +1 -1
- package/dist/esm/transports/base.js +41 -10
- package/dist/esm/transports/base.js.map +1 -1
- package/dist/esm/transports/dryModeRunner.d.ts +19 -0
- package/dist/esm/transports/dryModeRunner.d.ts.map +1 -0
- package/dist/esm/transports/dryModeRunner.js +33 -0
- package/dist/esm/transports/dryModeRunner.js.map +1 -0
- package/dist/esm/transports/inMemoryTransport.d.ts +18 -0
- package/dist/esm/transports/inMemoryTransport.d.ts.map +1 -0
- package/dist/esm/transports/inMemoryTransport.js +39 -0
- package/dist/esm/transports/inMemoryTransport.js.map +1 -0
- package/dist/esm/transports/streamableHttp.d.ts.map +1 -1
- package/dist/esm/transports/streamableHttp.js +5 -1
- package/dist/esm/transports/streamableHttp.js.map +1 -1
- package/package.json +60 -39
- package/dist/cjs/common/config.d.ts +0 -53
- package/dist/cjs/common/config.d.ts.map +0 -1
- package/dist/cjs/common/config.js +0 -401
- package/dist/cjs/common/config.js.map +0 -1
- package/dist/cjs/tools/mongodb/search/listSearchIndexes.d.ts +0 -30
- package/dist/cjs/tools/mongodb/search/listSearchIndexes.d.ts.map +0 -1
- package/dist/cjs/tools/mongodb/search/listSearchIndexes.js +0 -65
- package/dist/cjs/tools/mongodb/search/listSearchIndexes.js.map +0 -1
- package/dist/esm/common/config.d.ts +0 -53
- package/dist/esm/common/config.d.ts.map +0 -1
- package/dist/esm/common/config.js +0 -390
- package/dist/esm/common/config.js.map +0 -1
- package/dist/esm/tools/mongodb/search/listSearchIndexes.d.ts +0 -30
- package/dist/esm/tools/mongodb/search/listSearchIndexes.d.ts.map +0 -1
- package/dist/esm/tools/mongodb/search/listSearchIndexes.js +0 -61
- package/dist/esm/tools/mongodb/search/listSearchIndexes.js.map +0 -1
package/README.md
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
[](https://insiders.vscode.dev/redirect/mcp/install?name=mongodb&inputs=%5B%7B%22id%22%3A%22connection_string%22%2C%22type%22%3A%22promptString%22%2C%22description%22%3A%22MongoDB%20connection%20string%22%7D%5D&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22mongodb-mcp-server%22%2C%22--readOnly%22%5D%2C%22env%22%3A%7B%22MDB_MCP_CONNECTION_STRING%22%3A%22%24%7Binput%3Aconnection_string%7D%22%7D%7D)
|
|
2
|
-
[](https://cursor.com/install-mcp?name=MongoDB&config=eyJjb21tYW5kIjoibnB4IC15IG1vbmdvZGItbWNwLXNlcnZlciAtLXJlYWRPbmx5In0%3D)
|
|
2
|
+
[](https://cursor.com/en-US/install-mcp?name=MongoDB&config=eyJjb21tYW5kIjoibnB4IC15IG1vbmdvZGItbWNwLXNlcnZlciAtLXJlYWRPbmx5In0%3D)
|
|
3
3
|
|
|
4
4
|
# MongoDB MCP Server
|
|
5
5
|
|
|
@@ -23,6 +23,8 @@ A Model Context Protocol server for interacting with MongoDB Databases and Mongo
|
|
|
23
23
|
- [Command-Line Arguments](#command-line-arguments)
|
|
24
24
|
- [MCP Client Configuration](#mcp-configuration-file-examples)
|
|
25
25
|
- [Proxy Support](#proxy-support)
|
|
26
|
+
- [🚀 Deploy on Public Clouds](#deploy-on-public-clouds)
|
|
27
|
+
- [Azure Cloud](#azure)
|
|
26
28
|
- [🤝 Contributing](#contributing)
|
|
27
29
|
|
|
28
30
|
<a name="getting-started"></a>
|
|
@@ -293,22 +295,27 @@ npx -y mongodb-mcp-server@latest --transport http --httpHost=0.0.0.0 --httpPort=
|
|
|
293
295
|
- `atlas-list-db-users` - List MongoDB Atlas database users
|
|
294
296
|
- `atlas-create-db-user` - Creates a MongoDB Atlas database user
|
|
295
297
|
- `atlas-list-alerts` - List MongoDB Atlas Alerts for a Project
|
|
298
|
+
- `atlas-get-performance-advisor` - Gets Atlas Performance Advisor recommendations (index suggestions, drop index suggestions, schema suggestions, slow query logs)
|
|
296
299
|
|
|
297
300
|
NOTE: atlas tools are only available when you set credentials on [configuration](#configuration) section.
|
|
298
301
|
|
|
302
|
+
#### MongoDB Atlas Local Tools
|
|
303
|
+
|
|
304
|
+
- `atlas-local-list-deployments` - Lists MongoDB Atlas Local deployments
|
|
305
|
+
- `atlas-local-create-deployment` - Creates a MongoDB Atlas Local deployment
|
|
306
|
+
- `atlas-local-connect-deployment` - Connects to a MongoDB Atlas Local deployment
|
|
307
|
+
- `atlas-local-delete-deployment` - Deletes a MongoDB Atlas Local deployment
|
|
308
|
+
|
|
299
309
|
#### MongoDB Database Tools
|
|
300
310
|
|
|
301
311
|
- `connect` - Connect to a MongoDB instance
|
|
302
312
|
- `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.
|
|
303
313
|
- `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.
|
|
304
314
|
- `count` - Get the number of documents in a MongoDB collection
|
|
305
|
-
- `insert-one` - Insert a single document into a MongoDB collection
|
|
306
315
|
- `insert-many` - Insert multiple documents into a MongoDB collection
|
|
307
316
|
- `create-index` - Create an index for a MongoDB collection
|
|
308
|
-
- `update-one` - Update a single document in a MongoDB collection
|
|
309
317
|
- `update-many` - Update multiple documents in a MongoDB collection
|
|
310
318
|
- `rename-collection` - Rename a MongoDB collection
|
|
311
|
-
- `delete-one` - Delete a single document from a MongoDB collection
|
|
312
319
|
- `delete-many` - Delete multiple documents from a MongoDB collection
|
|
313
320
|
- `drop-collection` - Remove a collection from a MongoDB database
|
|
314
321
|
- `drop-database` - Remove a MongoDB database
|
|
@@ -337,30 +344,34 @@ The MongoDB MCP Server can be configured using multiple methods, with the follow
|
|
|
337
344
|
|
|
338
345
|
### Configuration Options
|
|
339
346
|
|
|
340
|
-
| CLI Option | Environment Variable | Default
|
|
341
|
-
| -------------------------------------- | --------------------------------------------------- |
|
|
342
|
-
| `
|
|
343
|
-
| `
|
|
344
|
-
| `
|
|
345
|
-
| `
|
|
346
|
-
| `
|
|
347
|
-
| `
|
|
348
|
-
| `
|
|
349
|
-
| `
|
|
350
|
-
| `
|
|
351
|
-
| `
|
|
352
|
-
| `
|
|
353
|
-
| `
|
|
354
|
-
| `httpHost` | `MDB_MCP_HTTP_HOST` | 127.0.0.1
|
|
355
|
-
| `
|
|
356
|
-
| `
|
|
357
|
-
| `
|
|
358
|
-
| `
|
|
359
|
-
| `
|
|
360
|
-
| `
|
|
361
|
-
| `
|
|
362
|
-
| `
|
|
363
|
-
| `
|
|
347
|
+
| CLI Option | Environment Variable | Default | Description |
|
|
348
|
+
| -------------------------------------- | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
349
|
+
| `allowRequestOverrides` | `MDB_MCP_ALLOW_REQUEST_OVERRIDES` | `false` | When set to true, allows configuration values to be overridden via request headers and query parameters. |
|
|
350
|
+
| `apiClientId` | `MDB_MCP_API_CLIENT_ID` | `<not set>` | Atlas API client ID for authentication. Required for running Atlas tools. |
|
|
351
|
+
| `apiClientSecret` | `MDB_MCP_API_CLIENT_SECRET` | `<not set>` | Atlas API client secret for authentication. Required for running Atlas tools. |
|
|
352
|
+
| `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. |
|
|
353
|
+
| `confirmationRequiredTools` | `MDB_MCP_CONFIRMATION_REQUIRED_TOOLS` | `"atlas-create-access-list,atlas-create-db-user,drop-database,drop-collection,delete-many,drop-index"` | Comma separated values of tool names that require user confirmation before execution. Requires the client to support elicitation. |
|
|
354
|
+
| `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. |
|
|
355
|
+
| `disabledTools` | `MDB_MCP_DISABLED_TOOLS` | `""` | Comma separated values of tool names, operation types, and/or categories of tools that will be disabled. |
|
|
356
|
+
| `dryRun` | `MDB_MCP_DRY_RUN` | `false` | When true, runs the server in dry mode: dumps configuration and enabled tools, then exits without starting the server. |
|
|
357
|
+
| `embeddingsValidation` | `MDB_MCP_EMBEDDINGS_VALIDATION` | `true` | When set to false, disables validation of embeddings dimensions. |
|
|
358
|
+
| `exportCleanupIntervalMs` | `MDB_MCP_EXPORT_CLEANUP_INTERVAL_MS` | `120000` | Time in milliseconds between export cleanup cycles that remove expired export files. |
|
|
359
|
+
| `exportTimeoutMs` | `MDB_MCP_EXPORT_TIMEOUT_MS` | `300000` | Time in milliseconds after which an export is considered expired and eligible for cleanup. |
|
|
360
|
+
| `exportsPath` | `MDB_MCP_EXPORTS_PATH` | see below\* | Folder to store exported data files. |
|
|
361
|
+
| `httpHost` | `MDB_MCP_HTTP_HOST` | `"127.0.0.1"` | Host address to bind the HTTP server to (only used when transport is 'http'). |
|
|
362
|
+
| `httpPort` | `MDB_MCP_HTTP_PORT` | `3000` | Port number for the HTTP server (only used when transport is 'http'). |
|
|
363
|
+
| `idleTimeoutMs` | `MDB_MCP_IDLE_TIMEOUT_MS` | `600000` | Idle timeout for a client to disconnect (only applies to http transport). |
|
|
364
|
+
| `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. |
|
|
365
|
+
| `logPath` | `MDB_MCP_LOG_PATH` | see below\* | Folder to store logs. |
|
|
366
|
+
| `loggers` | `MDB_MCP_LOGGERS` | `"disk,mcp"` see below\* | Comma separated values of logger types. |
|
|
367
|
+
| `maxBytesPerQuery` | `MDB_MCP_MAX_BYTES_PER_QUERY` | `16777216` | 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. |
|
|
368
|
+
| `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. |
|
|
369
|
+
| `notificationTimeoutMs` | `MDB_MCP_NOTIFICATION_TIMEOUT_MS` | `540000` | Notification timeout for a client to be aware of disconnect (only applies to http transport). |
|
|
370
|
+
| `previewFeatures` | `MDB_MCP_PREVIEW_FEATURES` | `""` | Comma separated values of preview features that are enabled. |
|
|
371
|
+
| `readOnly` | `MDB_MCP_READ_ONLY` | `false` | When set to true, only allows read, connect, and metadata operation types, disabling create/update/delete operations. |
|
|
372
|
+
| `telemetry` | `MDB_MCP_TELEMETRY` | `"enabled"` | When set to disabled, disables telemetry collection. |
|
|
373
|
+
| `transport` | `MDB_MCP_TRANSPORT` | `"stdio"` | Either 'stdio' or 'http'. |
|
|
374
|
+
| `voyageApiKey` | `MDB_MCP_VOYAGE_API_KEY` | `""` | API key for Voyage AI embeddings service (required for vector search operations with text-to-embedding conversion). |
|
|
364
375
|
|
|
365
376
|
#### Logger Options
|
|
366
377
|
|
|
@@ -397,6 +408,8 @@ When using the `disk` logger, log files are stored in:
|
|
|
397
408
|
|
|
398
409
|
You can override the log directory with the `logPath` option.
|
|
399
410
|
|
|
411
|
+
> **🔒 Security Guideline:** The user account running the MCP server must have both read and write permissions to the `logPath` directory. Ensure this directory is properly secured with appropriate file system permissions to prevent unauthorized access to log files.
|
|
412
|
+
|
|
400
413
|
#### Disabled Tools
|
|
401
414
|
|
|
402
415
|
You can disable specific tools or categories of tools by using the `disabledTools` option. This option accepts an array of strings,
|
|
@@ -470,6 +483,8 @@ The `exportTimeoutMs` configuration controls the time after which the exported d
|
|
|
470
483
|
|
|
471
484
|
The `exportCleanupIntervalMs` configuration controls how frequently the cleanup process runs to remove expired export files. By default, cleanup runs every 2 minutes (120000ms).
|
|
472
485
|
|
|
486
|
+
> **🔒 Security Guideline:** The user account running the MCP server must have both read and write permissions to the `exportsPath` directory. Ensure this directory is properly secured with appropriate file system permissions to prevent unauthorized access to exported data files, which may contain sensitive MongoDB data. Consider the sensitivity of your data when choosing the export location and apply restrictive permissions accordingly.
|
|
487
|
+
|
|
473
488
|
#### Telemetry
|
|
474
489
|
|
|
475
490
|
The `telemetry` configuration option allows you to disable telemetry collection. When enabled, the MCP server will collect usage data and send it to MongoDB.
|
|
@@ -482,6 +497,19 @@ You can disable telemetry using:
|
|
|
482
497
|
|
|
483
498
|
> **💡 Platform Note:** For Windows users, see [Environment Variables](#environment-variables) for platform-specific instructions.
|
|
484
499
|
|
|
500
|
+
#### Opting into Preview Features
|
|
501
|
+
|
|
502
|
+
The MongoDB MCP Server may offer functionality that is still in development and may change in future releases. These features are considered "preview features" and are not enabled by default. Generally, these features are well tested, but may not offer the complete functionality we intend to provide in the final release or we'd like to gather feedback before making them generally available. To enable one or more preview features, use the `previewFeatures` configuration option.
|
|
503
|
+
|
|
504
|
+
- For **environment variable** configuration, use a comma-separated string: `export MDB_MCP_PREVIEW_FEATURES="search,feature1,feature2"`.
|
|
505
|
+
- For **command-line argument** configuration, use a space-separated string: `--previewFeatures search feature1 feature2`.
|
|
506
|
+
|
|
507
|
+
List of available preview features:
|
|
508
|
+
|
|
509
|
+
- `search` - Enables tools or functionality related to Atlas Search and Vector Search in MongoDB Atlas:
|
|
510
|
+
- Index management, such as creating, listing, and dropping search and vector search indexes.
|
|
511
|
+
- Querying collections using vector search capabilities. This requires a configured embedding model that will be used to generate vector representations of the query data. Currently, only [Voyage AI](https://www.voyageai.com) embedding models are supported. Set the `voyageApiKey` configuration option with your Voyage AI API key to use this feature.
|
|
512
|
+
|
|
485
513
|
### Atlas API Access
|
|
486
514
|
|
|
487
515
|
To use the Atlas API tools, you'll need to create a service account in MongoDB Atlas:
|
|
@@ -680,6 +708,14 @@ connecting to the Atlas API, your MongoDB Cluster, or any other external calls
|
|
|
680
708
|
to third-party services like OID Providers. The behaviour is the same as what
|
|
681
709
|
`mongosh` does, so the same settings will work in the MCP Server.
|
|
682
710
|
|
|
711
|
+
## 🚀Deploy on Public Clouds
|
|
712
|
+
|
|
713
|
+
You can deploy the MongoDB MCP Server to your preferred cloud provider using the deployment assets under `deploy/`. Each guide explains the prerequisites, configuration, and automation scripts that streamline the rollout.
|
|
714
|
+
|
|
715
|
+
### Azure
|
|
716
|
+
|
|
717
|
+
For detailed Azure instructions, see [deploy/azure/README.md](deploy/azure/README.md).
|
|
718
|
+
|
|
683
719
|
## 🤝Contributing
|
|
684
720
|
|
|
685
721
|
Interested in contributing? Great! Please check our [Contributing Guide](CONTRIBUTING.md) for guidelines on code contributions, standards, adding new tools, and troubleshooting information.
|
|
@@ -24,7 +24,7 @@ async function makeCurrentIpAccessListEntry(apiClient, projectId, comment = expo
|
|
|
24
24
|
async function ensureCurrentIpInAccessList(apiClient, projectId) {
|
|
25
25
|
const entry = await makeCurrentIpAccessListEntry(apiClient, projectId, exports.DEFAULT_ACCESS_LIST_COMMENT);
|
|
26
26
|
try {
|
|
27
|
-
await apiClient.
|
|
27
|
+
await apiClient.createAccessListEntry({
|
|
28
28
|
params: { path: { groupId: projectId } },
|
|
29
29
|
body: [entry],
|
|
30
30
|
});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"accessListUtils.js","sourceRoot":"","sources":["../../../../src/common/atlas/accessListUtils.ts"],"names":[],"mappings":";;;AAMA,oEAWC;AASD,kEA8BC;AAvDD,4CAAqC;AACrC,2DAAqD;AAExC,QAAA,2BAA2B,GAAG,mDAAmD,CAAC;AAExF,KAAK,UAAU,4BAA4B,CAC9C,SAAoB,EACpB,SAAiB,EACjB,UAAkB,mCAA2B;IAE7C,MAAM,EAAE,kBAAkB,EAAE,GAAG,MAAM,SAAS,CAAC,SAAS,EAAE,CAAC;IAC3D,OAAO;QACH,OAAO,EAAE,SAAS;QAClB,SAAS,EAAE,kBAAkB;QAC7B,OAAO;KACV,CAAC;AACN,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,2BAA2B,CAAC,SAAoB,EAAE,SAAiB;IACrF,MAAM,KAAK,GAAG,MAAM,4BAA4B,CAAC,SAAS,EAAE,SAAS,EAAE,mCAA2B,CAAC,CAAC;IACpG,IAAI,CAAC;QACD,MAAM,SAAS,CAAC,
|
|
1
|
+
{"version":3,"file":"accessListUtils.js","sourceRoot":"","sources":["../../../../src/common/atlas/accessListUtils.ts"],"names":[],"mappings":";;;AAMA,oEAWC;AASD,kEA8BC;AAvDD,4CAAqC;AACrC,2DAAqD;AAExC,QAAA,2BAA2B,GAAG,mDAAmD,CAAC;AAExF,KAAK,UAAU,4BAA4B,CAC9C,SAAoB,EACpB,SAAiB,EACjB,UAAkB,mCAA2B;IAE7C,MAAM,EAAE,kBAAkB,EAAE,GAAG,MAAM,SAAS,CAAC,SAAS,EAAE,CAAC;IAC3D,OAAO;QACH,OAAO,EAAE,SAAS;QAClB,SAAS,EAAE,kBAAkB;QAC7B,OAAO;KACV,CAAC;AACN,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,2BAA2B,CAAC,SAAoB,EAAE,SAAiB;IACrF,MAAM,KAAK,GAAG,MAAM,4BAA4B,CAAC,SAAS,EAAE,SAAS,EAAE,mCAA2B,CAAC,CAAC;IACpG,IAAI,CAAC;QACD,MAAM,SAAS,CAAC,qBAAqB,CAAC;YAClC,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,EAAE;YACxC,IAAI,EAAE,CAAC,KAAK,CAAC;SAChB,CAAC,CAAC;QACH,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC;YACnB,EAAE,EAAE,iBAAK,CAAC,sBAAsB;YAChC,OAAO,EAAE,iBAAiB;YAC1B,OAAO,EAAE,2BAA2B,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE;SAC9D,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IAChB,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACX,IAAI,GAAG,YAAY,kCAAc,IAAI,GAAG,CAAC,QAAQ,EAAE,MAAM,KAAK,GAAG,EAAE,CAAC;YAChE,+CAA+C;YAC/C,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC;gBACnB,EAAE,EAAE,iBAAK,CAAC,sBAAsB;gBAChC,OAAO,EAAE,iBAAiB;gBAC1B,OAAO,EAAE,cAAc,KAAK,CAAC,SAAS,sDAAsD,SAAS,GAAG;aAC3G,CAAC,CAAC;YACH,OAAO,KAAK,CAAC;QACjB,CAAC;QACD,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC;YACrB,EAAE,EAAE,iBAAK,CAAC,2BAA2B;YACrC,OAAO,EAAE,iBAAiB;YAC1B,OAAO,EAAE,gCAAgC,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE;SAC9F,CAAC,CAAC;IACP,CAAC;IACD,OAAO,KAAK,CAAC;AACjB,CAAC"}
|
|
@@ -38,17 +38,17 @@ export declare class ApiClient {
|
|
|
38
38
|
sendEvents(events: TelemetryEvent<CommonProperties>[]): Promise<void>;
|
|
39
39
|
private sendAuthEvents;
|
|
40
40
|
private sendUnauthEvents;
|
|
41
|
-
|
|
41
|
+
listClusterDetails(options?: FetchOptions<operations["listClusterDetails"]>): Promise<{
|
|
42
42
|
readonly links?: import("./openapi.js").components["schemas"]["Link"][];
|
|
43
43
|
readonly results?: import("./openapi.js").components["schemas"]["OrgGroup"][];
|
|
44
44
|
readonly totalCount?: number;
|
|
45
45
|
}>;
|
|
46
|
-
|
|
46
|
+
listGroups(options?: FetchOptions<operations["listGroups"]>): Promise<{
|
|
47
47
|
readonly links?: import("./openapi.js").components["schemas"]["Link"][];
|
|
48
48
|
readonly results?: import("./openapi.js").components["schemas"]["Group"][];
|
|
49
49
|
readonly totalCount?: number;
|
|
50
50
|
}>;
|
|
51
|
-
|
|
51
|
+
createGroup(options: FetchOptions<operations["createGroup"]>): Promise<{
|
|
52
52
|
readonly clusterCount: number;
|
|
53
53
|
readonly created: string;
|
|
54
54
|
readonly id?: string;
|
|
@@ -59,8 +59,8 @@ export declare class ApiClient {
|
|
|
59
59
|
tags?: import("./openapi.js").components["schemas"]["ResourceTag"][];
|
|
60
60
|
withDefaultAlertsSettings: boolean;
|
|
61
61
|
}>;
|
|
62
|
-
|
|
63
|
-
|
|
62
|
+
deleteGroup(options: FetchOptions<operations["deleteGroup"]>): Promise<void>;
|
|
63
|
+
getGroup(options: FetchOptions<operations["getGroup"]>): Promise<{
|
|
64
64
|
readonly clusterCount: number;
|
|
65
65
|
readonly created: string;
|
|
66
66
|
readonly id?: string;
|
|
@@ -71,28 +71,28 @@ export declare class ApiClient {
|
|
|
71
71
|
tags?: import("./openapi.js").components["schemas"]["ResourceTag"][];
|
|
72
72
|
withDefaultAlertsSettings: boolean;
|
|
73
73
|
}>;
|
|
74
|
-
|
|
74
|
+
listAccessListEntries(options: FetchOptions<operations["listGroupAccessListEntries"]>): Promise<{
|
|
75
75
|
readonly links?: import("./openapi.js").components["schemas"]["Link"][];
|
|
76
76
|
readonly results?: import("./openapi.js").components["schemas"]["NetworkPermissionEntry"][];
|
|
77
77
|
readonly totalCount?: number;
|
|
78
78
|
}>;
|
|
79
|
-
|
|
79
|
+
createAccessListEntry(options: FetchOptions<operations["createGroupAccessListEntry"]>): Promise<{
|
|
80
80
|
readonly links?: import("./openapi.js").components["schemas"]["Link"][];
|
|
81
81
|
readonly results?: import("./openapi.js").components["schemas"]["NetworkPermissionEntry"][];
|
|
82
82
|
readonly totalCount?: number;
|
|
83
83
|
}>;
|
|
84
|
-
|
|
85
|
-
listAlerts(options: FetchOptions<operations["
|
|
84
|
+
deleteAccessListEntry(options: FetchOptions<operations["deleteGroupAccessListEntry"]>): Promise<void>;
|
|
85
|
+
listAlerts(options: FetchOptions<operations["listGroupAlerts"]>): Promise<{
|
|
86
86
|
readonly links?: import("./openapi.js").components["schemas"]["Link"][];
|
|
87
87
|
readonly results?: import("./openapi.js").components["schemas"]["AlertViewForNdsGroup"][];
|
|
88
88
|
readonly totalCount?: number;
|
|
89
89
|
}>;
|
|
90
|
-
listClusters(options: FetchOptions<operations["
|
|
90
|
+
listClusters(options: FetchOptions<operations["listGroupClusters"]>): Promise<{
|
|
91
91
|
readonly links?: import("./openapi.js").components["schemas"]["Link"][];
|
|
92
92
|
readonly results?: import("./openapi.js").components["schemas"]["ClusterDescription20240805"][];
|
|
93
93
|
readonly totalCount?: number;
|
|
94
94
|
}>;
|
|
95
|
-
createCluster(options: FetchOptions<operations["
|
|
95
|
+
createCluster(options: FetchOptions<operations["createGroupCluster"]>): Promise<{
|
|
96
96
|
acceptDataRisksAndForceReplicaSetReconfig?: string;
|
|
97
97
|
advancedConfiguration?: import("./openapi.js").components["schemas"]["ApiAtlasClusterAdvancedConfigurationView"];
|
|
98
98
|
backupEnabled: boolean;
|
|
@@ -109,6 +109,7 @@ export declare class ApiClient {
|
|
|
109
109
|
globalClusterSelfManagedSharding?: boolean;
|
|
110
110
|
readonly groupId?: string;
|
|
111
111
|
readonly id?: string;
|
|
112
|
+
readonly internalClusterRole?: "NONE" | "SYSTEM_CLUSTER" | "INTERNAL_SHADOW_CLUSTER";
|
|
112
113
|
labels?: import("./openapi.js").components["schemas"]["ComponentLabel"][];
|
|
113
114
|
readonly links?: import("./openapi.js").components["schemas"]["Link"][];
|
|
114
115
|
mongoDBEmployeeAccessGrant?: import("./openapi.js").components["schemas"]["EmployeeAccessGrantView"];
|
|
@@ -124,10 +125,11 @@ export declare class ApiClient {
|
|
|
124
125
|
readonly stateName?: "IDLE" | "CREATING" | "UPDATING" | "DELETING" | "REPAIRING";
|
|
125
126
|
tags?: import("./openapi.js").components["schemas"]["ResourceTag"][];
|
|
126
127
|
terminationProtectionEnabled: boolean;
|
|
128
|
+
useAwsTimeBasedSnapshotCopyForFastInitialSync: boolean;
|
|
127
129
|
versionReleaseSystem: "LTS" | "CONTINUOUS";
|
|
128
130
|
}>;
|
|
129
|
-
deleteCluster(options: FetchOptions<operations["
|
|
130
|
-
getCluster(options: FetchOptions<operations["
|
|
131
|
+
deleteCluster(options: FetchOptions<operations["deleteGroupCluster"]>): Promise<void>;
|
|
132
|
+
getCluster(options: FetchOptions<operations["getGroupCluster"]>): Promise<{
|
|
131
133
|
acceptDataRisksAndForceReplicaSetReconfig?: string;
|
|
132
134
|
advancedConfiguration?: import("./openapi.js").components["schemas"]["ApiAtlasClusterAdvancedConfigurationView"];
|
|
133
135
|
backupEnabled: boolean;
|
|
@@ -144,6 +146,7 @@ export declare class ApiClient {
|
|
|
144
146
|
globalClusterSelfManagedSharding?: boolean;
|
|
145
147
|
readonly groupId?: string;
|
|
146
148
|
readonly id?: string;
|
|
149
|
+
readonly internalClusterRole?: "NONE" | "SYSTEM_CLUSTER" | "INTERNAL_SHADOW_CLUSTER";
|
|
147
150
|
labels?: import("./openapi.js").components["schemas"]["ComponentLabel"][];
|
|
148
151
|
readonly links?: import("./openapi.js").components["schemas"]["Link"][];
|
|
149
152
|
mongoDBEmployeeAccessGrant?: import("./openapi.js").components["schemas"]["EmployeeAccessGrantView"];
|
|
@@ -159,26 +162,27 @@ export declare class ApiClient {
|
|
|
159
162
|
readonly stateName?: "IDLE" | "CREATING" | "UPDATING" | "DELETING" | "REPAIRING";
|
|
160
163
|
tags?: import("./openapi.js").components["schemas"]["ResourceTag"][];
|
|
161
164
|
terminationProtectionEnabled: boolean;
|
|
165
|
+
useAwsTimeBasedSnapshotCopyForFastInitialSync: boolean;
|
|
162
166
|
versionReleaseSystem: "LTS" | "CONTINUOUS";
|
|
163
167
|
}>;
|
|
164
|
-
|
|
168
|
+
listDropIndexSuggestions(options: FetchOptions<operations["listGroupClusterPerformanceAdvisorDropIndexSuggestions"]>): Promise<{
|
|
165
169
|
readonly hiddenIndexes?: import("./openapi.js").components["schemas"]["DropIndexSuggestionsIndex"][];
|
|
166
170
|
readonly redundantIndexes?: import("./openapi.js").components["schemas"]["DropIndexSuggestionsIndex"][];
|
|
167
171
|
readonly unusedIndexes?: import("./openapi.js").components["schemas"]["DropIndexSuggestionsIndex"][];
|
|
168
172
|
}>;
|
|
169
|
-
listSchemaAdvice(options: FetchOptions<operations["
|
|
173
|
+
listSchemaAdvice(options: FetchOptions<operations["listGroupClusterPerformanceAdvisorSchemaAdvice"]>): Promise<{
|
|
170
174
|
readonly recommendations?: import("./openapi.js").components["schemas"]["SchemaAdvisorItemRecommendation"][];
|
|
171
175
|
}>;
|
|
172
|
-
listClusterSuggestedIndexes(options: FetchOptions<operations["
|
|
176
|
+
listClusterSuggestedIndexes(options: FetchOptions<operations["listGroupClusterPerformanceAdvisorSuggestedIndexes"]>): Promise<{
|
|
173
177
|
readonly shapes?: import("./openapi.js").components["schemas"]["PerformanceAdvisorShape"][];
|
|
174
178
|
readonly suggestedIndexes?: import("./openapi.js").components["schemas"]["PerformanceAdvisorIndex"][];
|
|
175
179
|
}>;
|
|
176
|
-
listDatabaseUsers(options: FetchOptions<operations["
|
|
180
|
+
listDatabaseUsers(options: FetchOptions<operations["listGroupDatabaseUsers"]>): Promise<{
|
|
177
181
|
readonly links?: import("./openapi.js").components["schemas"]["Link"][];
|
|
178
182
|
readonly results?: import("./openapi.js").components["schemas"]["CloudDatabaseUser"][];
|
|
179
183
|
readonly totalCount?: number;
|
|
180
184
|
}>;
|
|
181
|
-
createDatabaseUser(options: FetchOptions<operations["
|
|
185
|
+
createDatabaseUser(options: FetchOptions<operations["createGroupDatabaseUser"]>): Promise<{
|
|
182
186
|
awsIAMType: "NONE" | "USER" | "ROLE";
|
|
183
187
|
databaseName: "admin" | "$external";
|
|
184
188
|
deleteAfterDate?: string;
|
|
@@ -194,13 +198,13 @@ export declare class ApiClient {
|
|
|
194
198
|
username: string;
|
|
195
199
|
x509Type: "NONE" | "CUSTOMER" | "MANAGED";
|
|
196
200
|
}>;
|
|
197
|
-
deleteDatabaseUser(options: FetchOptions<operations["
|
|
198
|
-
listFlexClusters(options: FetchOptions<operations["
|
|
201
|
+
deleteDatabaseUser(options: FetchOptions<operations["deleteGroupDatabaseUser"]>): Promise<void>;
|
|
202
|
+
listFlexClusters(options: FetchOptions<operations["listGroupFlexClusters"]>): Promise<{
|
|
199
203
|
readonly links?: import("./openapi.js").components["schemas"]["Link"][];
|
|
200
204
|
readonly results?: import("./openapi.js").components["schemas"]["FlexClusterDescription20241113"][];
|
|
201
205
|
readonly totalCount?: number;
|
|
202
206
|
}>;
|
|
203
|
-
createFlexCluster(options: FetchOptions<operations["
|
|
207
|
+
createFlexCluster(options: FetchOptions<operations["createGroupFlexCluster"]>): Promise<{
|
|
204
208
|
backupSettings?: import("./openapi.js").components["schemas"]["FlexBackupSettings20241113"];
|
|
205
209
|
readonly clusterType: "REPLICASET";
|
|
206
210
|
connectionStrings?: import("./openapi.js").components["schemas"]["FlexConnectionStrings20241113"];
|
|
@@ -216,8 +220,8 @@ export declare class ApiClient {
|
|
|
216
220
|
terminationProtectionEnabled: boolean;
|
|
217
221
|
readonly versionReleaseSystem: "LTS";
|
|
218
222
|
}>;
|
|
219
|
-
deleteFlexCluster(options: FetchOptions<operations["
|
|
220
|
-
getFlexCluster(options: FetchOptions<operations["
|
|
223
|
+
deleteFlexCluster(options: FetchOptions<operations["deleteGroupFlexCluster"]>): Promise<void>;
|
|
224
|
+
getFlexCluster(options: FetchOptions<operations["getGroupFlexCluster"]>): Promise<{
|
|
221
225
|
backupSettings?: import("./openapi.js").components["schemas"]["FlexBackupSettings20241113"];
|
|
222
226
|
readonly clusterType: "REPLICASET";
|
|
223
227
|
connectionStrings?: import("./openapi.js").components["schemas"]["FlexConnectionStrings20241113"];
|
|
@@ -233,15 +237,15 @@ export declare class ApiClient {
|
|
|
233
237
|
terminationProtectionEnabled: boolean;
|
|
234
238
|
readonly versionReleaseSystem: "LTS";
|
|
235
239
|
}>;
|
|
236
|
-
|
|
240
|
+
listSlowQueryLogs(options: FetchOptions<operations["listGroupProcessPerformanceAdvisorSlowQueryLogs"]>): Promise<{
|
|
237
241
|
readonly slowQueries?: import("./openapi.js").components["schemas"]["PerformanceAdvisorSlowQuery"][];
|
|
238
242
|
}>;
|
|
239
|
-
|
|
243
|
+
listOrgs(options?: FetchOptions<operations["listOrgs"]>): Promise<{
|
|
240
244
|
readonly links?: import("./openapi.js").components["schemas"]["Link"][];
|
|
241
245
|
readonly results?: import("./openapi.js").components["schemas"]["AtlasOrganization"][];
|
|
242
246
|
readonly totalCount?: number;
|
|
243
247
|
}>;
|
|
244
|
-
|
|
248
|
+
getOrgGroups(options: FetchOptions<operations["getOrgGroups"]>): Promise<{
|
|
245
249
|
readonly links?: import("./openapi.js").components["schemas"]["Link"][];
|
|
246
250
|
readonly results?: import("./openapi.js").components["schemas"]["Group"][];
|
|
247
251
|
readonly totalCount?: number;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"apiClient.d.ts","sourceRoot":"","sources":["../../../../src/common/atlas/apiClient.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAiB,YAAY,EAAsB,MAAM,eAAe,CAAC;AAErF,OAAO,KAAK,EAAS,UAAU,EAAE,MAAM,cAAc,CAAC;AACtD,OAAO,KAAK,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAEjF,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAQ/C,MAAM,WAAW,oBAAoB;IACjC,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,gBAAgB;IAC7B,WAAW,CAAC,EAAE,oBAAoB,CAAC;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,WAAW;IACxB,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,qBAAa,SAAS;aAqEE,MAAM,EAAE,UAAU;IApEtC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAOtB;IAMF,OAAO,CAAC,MAAM,CAAC,WAAW,CAEI;IAE9B,OAAO,CAAC,MAAM,CAAgB;IAE9B,OAAO,CAAC,YAAY,CAAC,CAAe;IACpC,OAAO,CAAC,YAAY,CAAC,CAA4B;IACjD,OAAO,CAAC,WAAW,CAAC,CAAc;IAE3B,cAAc,IAAI,OAAO;IAIhC,OAAO,CAAC,kBAAkB;IAQ1B,OAAO,CAAC,cAAc,CAUpB;IAEF,OAAO,CAAC,cAAc,CAiBpB;gBAGE,OAAO,EAAE,gBAAgB,EACT,MAAM,EAAE,UAAU;IAwCtC,OAAO,CAAC,kBAAkB;YAmBZ,iBAAiB;IAwClB,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC;IAIpC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAiBtB,SAAS,IAAI,OAAO,CAAC;QAC9B,kBAAkB,EAAE,MAAM,CAAC;KAC9B,CAAC;IAuBW,UAAU,CAAC,MAAM,EAAE,cAAc,CAAC,gBAAgB,CAAC,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;YAsBpE,cAAc;YAsBd,gBAAgB;IAqBxB,
|
|
1
|
+
{"version":3,"file":"apiClient.d.ts","sourceRoot":"","sources":["../../../../src/common/atlas/apiClient.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAiB,YAAY,EAAsB,MAAM,eAAe,CAAC;AAErF,OAAO,KAAK,EAAS,UAAU,EAAE,MAAM,cAAc,CAAC;AACtD,OAAO,KAAK,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAEjF,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAQ/C,MAAM,WAAW,oBAAoB;IACjC,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,gBAAgB;IAC7B,WAAW,CAAC,EAAE,oBAAoB,CAAC;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,WAAW;IACxB,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,qBAAa,SAAS;aAqEE,MAAM,EAAE,UAAU;IApEtC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAOtB;IAMF,OAAO,CAAC,MAAM,CAAC,WAAW,CAEI;IAE9B,OAAO,CAAC,MAAM,CAAgB;IAE9B,OAAO,CAAC,YAAY,CAAC,CAAe;IACpC,OAAO,CAAC,YAAY,CAAC,CAA4B;IACjD,OAAO,CAAC,WAAW,CAAC,CAAc;IAE3B,cAAc,IAAI,OAAO;IAIhC,OAAO,CAAC,kBAAkB;IAQ1B,OAAO,CAAC,cAAc,CAUpB;IAEF,OAAO,CAAC,cAAc,CAiBpB;gBAGE,OAAO,EAAE,gBAAgB,EACT,MAAM,EAAE,UAAU;IAwCtC,OAAO,CAAC,kBAAkB;YAmBZ,iBAAiB;IAwClB,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC;IAIpC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAiBtB,SAAS,IAAI,OAAO,CAAC;QAC9B,kBAAkB,EAAE,MAAM,CAAC;KAC9B,CAAC;IAuBW,UAAU,CAAC,MAAM,EAAE,cAAc,CAAC,gBAAgB,CAAC,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;YAsBpE,cAAc;YAsBd,gBAAgB;IAqBxB,kBAAkB,CAAC,OAAO,CAAC,EAAE,YAAY,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC;yBAiR0/9R,4CAAsB;2BAA+J,4CAAsB;;;IAxQhx+R,UAAU,CAAC,OAAO,CAAC,EAAE,YAAY,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;yBAwQo73R,4CAAsB;2BAA+J,4CAAsB;;;IA/P1r4R,WAAW,CAAC,OAAO,EAAE,YAAY,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;;;;yBA+P2zzN,4CAAsB;;;;eAA+wC,4CAAsB;;;IAtPlr2N,WAAW,CAAC,OAAO,EAAE,YAAY,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IAQ5D,QAAQ,CAAC,OAAO,EAAE,YAAY,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;;;;yBA8Oi0zN,4CAAsB;;;;eAA+wC,4CAAsB;;;IArOlr2N,qBAAqB,CAAC,OAAO,EAAE,YAAY,CAAC,UAAU,CAAC,4BAA4B,CAAC,CAAC;yBAqOgu8R,4CAAsB;2BAA+J,4CAAsB;;;IA5Nhg9R,qBAAqB,CAAC,OAAO,EAAE,YAAY,CAAC,UAAU,CAAC,4BAA4B,CAAC,CAAC;yBA4Ngu8R,4CAAsB;2BAA+J,4CAAsB;;;IAnNhg9R,qBAAqB,CAAC,OAAO,EAAE,YAAY,CAAC,UAAU,CAAC,4BAA4B,CAAC,CAAC;IAWrF,UAAU,CAAC,OAAO,EAAE,YAAY,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC;yBAwMwx0R,4CAAsB;2BAA+J,4CAAsB;;;IA/Lli1R,YAAY,CAAC,OAAO,EAAE,YAAY,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC;yBA+Lyr5R,4CAAsB;2BAA+J,4CAAsB;;;IAtLv85R,aAAa,CAAC,OAAO,EAAE,YAAY,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC;;gCAsLyiiH,4CAAsB;;sBAA8jB,4CAAsB;;;;4BAAghC,4CAAsB;;;;;;;;;;iBAAu7G,4CAAsB;yBAA+O,4CAAsB;qCAAoD,4CAAsB;;;;;;;;2BAA0kH,4CAAsB;;;eAA+sD,4CAAsB;;;;;IA7K/13H,aAAa,CAAC,OAAO,EAAE,YAAY,CAAC,UAAU,CAAC,oBAAoB,CAAC,CAAC;IAWrE,UAAU,CAAC,OAAO,EAAE,YAAY,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC;;gCAkK+iiH,4CAAsB;;sBAA8jB,4CAAsB;;;;4BAAghC,4CAAsB;;;;;;;;;;iBAAu7G,4CAAsB;yBAA+O,4CAAsB;qCAAoD,4CAAsB;;;;;;;;2BAA0kH,4CAAsB;;;eAA+sD,4CAAsB;;;;;IAtJ/13H,wBAAwB,CAC1B,OAAO,EAAE,YAAY,CAAC,UAAU,CAAC,wDAAwD,CAAC,CAAC;iCAqJ45lM,4CAAsB;oCAAuO,4CAAsB;iCAAiO,4CAAsB;;IAxI//mM,gBAAgB,CAAC,OAAO,EAAE,YAAY,CAAC,UAAU,CAAC,gDAAgD,CAAC,CAAC;mCAwIwj1T,4CAAsB;;IA5Hlr1T,2BAA2B,CAC7B,OAAO,EAAE,YAAY,CAAC,UAAU,CAAC,oDAAoD,CAAC,CAAC;0BA2Hm3mS,4CAAsB;oCAAiN,4CAAsB;;IA9GrsnS,iBAAiB,CAAC,OAAO,EAAE,YAAY,CAAC,UAAU,CAAC,wBAAwB,CAAC,CAAC;yBA8Gqp2R,4CAAsB;2BAA+J,4CAAsB;;;IAlG762R,kBAAkB,CAAC,OAAO,EAAE,YAAY,CAAC,UAAU,CAAC,yBAAyB,CAAC,CAAC;;;;;;iBAkGwrqE,4CAAsB;;yBAAuiB,4CAAsB;;;gBAAg4B,4CAAsB;iBAA0W,4CAAsB;;;;IAtFhnuE,kBAAkB,CAAC,OAAO,EAAE,YAAY,CAAC,UAAU,CAAC,yBAAyB,CAAC,CAAC;IAW/E,gBAAgB,CAAC,OAAO,EAAE,YAAY,CAAC,UAAU,CAAC,uBAAuB,CAAC,CAAC;yBA2E686R,4CAAsB;2BAA+J,4CAAsB;;;IAlEnu7R,iBAAiB,CAAC,OAAO,EAAE,YAAY,CAAC,UAAU,CAAC,wBAAwB,CAAC,CAAC;yBAkEuvqM,4CAAsB;;4BAAmQ,4CAAsB;;;;yBAAi6B,4CAAsB;;;0BAAyR,4CAAsB;;eAAy7C,4CAAsB;;;;IAtDxywM,iBAAiB,CAAC,OAAO,EAAE,YAAY,CAAC,UAAU,CAAC,wBAAwB,CAAC,CAAC;IAW7E,cAAc,CAAC,OAAO,EAAE,YAAY,CAAC,UAAU,CAAC,qBAAqB,CAAC,CAAC;yBA2C6vqM,4CAAsB;;4BAAmQ,4CAAsB;;;;yBAAi6B,4CAAsB;;;0BAAyR,4CAAsB;;eAAy7C,4CAAsB;;;;IA/BxywM,iBAAiB,CAAC,OAAO,EAAE,YAAY,CAAC,UAAU,CAAC,iDAAiD,CAAC,CAAC;+BA+B48rS,4CAAsB;;IAnBxksS,QAAQ,CAAC,OAAO,CAAC,EAAE,YAAY,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;yBAmBox/R,4CAAsB;2BAA+J,4CAAsB;;;IAVthgS,YAAY,CAAC,OAAO,EAAE,YAAY,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;yBAUi73R,4CAAsB;2BAA+J,4CAAsB;;;CADns4R"}
|
|
@@ -257,7 +257,7 @@ class ApiClient {
|
|
|
257
257
|
}
|
|
258
258
|
// DO NOT EDIT. This is auto-generated code.
|
|
259
259
|
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
|
|
260
|
-
async
|
|
260
|
+
async listClusterDetails(options) {
|
|
261
261
|
const { data, error, response } = await this.client.GET("/api/atlas/v2/clusters", options);
|
|
262
262
|
if (error) {
|
|
263
263
|
throw apiClientError_js_1.ApiClientError.fromError(response, error);
|
|
@@ -265,7 +265,7 @@ class ApiClient {
|
|
|
265
265
|
return data;
|
|
266
266
|
}
|
|
267
267
|
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
|
|
268
|
-
async
|
|
268
|
+
async listGroups(options) {
|
|
269
269
|
const { data, error, response } = await this.client.GET("/api/atlas/v2/groups", options);
|
|
270
270
|
if (error) {
|
|
271
271
|
throw apiClientError_js_1.ApiClientError.fromError(response, error);
|
|
@@ -273,7 +273,7 @@ class ApiClient {
|
|
|
273
273
|
return data;
|
|
274
274
|
}
|
|
275
275
|
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
|
|
276
|
-
async
|
|
276
|
+
async createGroup(options) {
|
|
277
277
|
const { data, error, response } = await this.client.POST("/api/atlas/v2/groups", options);
|
|
278
278
|
if (error) {
|
|
279
279
|
throw apiClientError_js_1.ApiClientError.fromError(response, error);
|
|
@@ -281,14 +281,14 @@ class ApiClient {
|
|
|
281
281
|
return data;
|
|
282
282
|
}
|
|
283
283
|
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
|
|
284
|
-
async
|
|
284
|
+
async deleteGroup(options) {
|
|
285
285
|
const { error, response } = await this.client.DELETE("/api/atlas/v2/groups/{groupId}", options);
|
|
286
286
|
if (error) {
|
|
287
287
|
throw apiClientError_js_1.ApiClientError.fromError(response, error);
|
|
288
288
|
}
|
|
289
289
|
}
|
|
290
290
|
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
|
|
291
|
-
async
|
|
291
|
+
async getGroup(options) {
|
|
292
292
|
const { data, error, response } = await this.client.GET("/api/atlas/v2/groups/{groupId}", options);
|
|
293
293
|
if (error) {
|
|
294
294
|
throw apiClientError_js_1.ApiClientError.fromError(response, error);
|
|
@@ -296,7 +296,7 @@ class ApiClient {
|
|
|
296
296
|
return data;
|
|
297
297
|
}
|
|
298
298
|
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
|
|
299
|
-
async
|
|
299
|
+
async listAccessListEntries(options) {
|
|
300
300
|
const { data, error, response } = await this.client.GET("/api/atlas/v2/groups/{groupId}/accessList", options);
|
|
301
301
|
if (error) {
|
|
302
302
|
throw apiClientError_js_1.ApiClientError.fromError(response, error);
|
|
@@ -304,7 +304,7 @@ class ApiClient {
|
|
|
304
304
|
return data;
|
|
305
305
|
}
|
|
306
306
|
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
|
|
307
|
-
async
|
|
307
|
+
async createAccessListEntry(options) {
|
|
308
308
|
const { data, error, response } = await this.client.POST("/api/atlas/v2/groups/{groupId}/accessList", options);
|
|
309
309
|
if (error) {
|
|
310
310
|
throw apiClientError_js_1.ApiClientError.fromError(response, error);
|
|
@@ -312,7 +312,7 @@ class ApiClient {
|
|
|
312
312
|
return data;
|
|
313
313
|
}
|
|
314
314
|
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
|
|
315
|
-
async
|
|
315
|
+
async deleteAccessListEntry(options) {
|
|
316
316
|
const { error, response } = await this.client.DELETE("/api/atlas/v2/groups/{groupId}/accessList/{entryValue}", options);
|
|
317
317
|
if (error) {
|
|
318
318
|
throw apiClientError_js_1.ApiClientError.fromError(response, error);
|
|
@@ -358,7 +358,7 @@ class ApiClient {
|
|
|
358
358
|
return data;
|
|
359
359
|
}
|
|
360
360
|
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
|
|
361
|
-
async
|
|
361
|
+
async listDropIndexSuggestions(options) {
|
|
362
362
|
const { data, error, response } = await this.client.GET("/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/performanceAdvisor/dropIndexSuggestions", options);
|
|
363
363
|
if (error) {
|
|
364
364
|
throw apiClientError_js_1.ApiClientError.fromError(response, error);
|
|
@@ -436,7 +436,7 @@ class ApiClient {
|
|
|
436
436
|
return data;
|
|
437
437
|
}
|
|
438
438
|
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
|
|
439
|
-
async
|
|
439
|
+
async listSlowQueryLogs(options) {
|
|
440
440
|
const { data, error, response } = await this.client.GET("/api/atlas/v2/groups/{groupId}/processes/{processId}/performanceAdvisor/slowQueryLogs", options);
|
|
441
441
|
if (error) {
|
|
442
442
|
throw apiClientError_js_1.ApiClientError.fromError(response, error);
|
|
@@ -444,7 +444,7 @@ class ApiClient {
|
|
|
444
444
|
return data;
|
|
445
445
|
}
|
|
446
446
|
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
|
|
447
|
-
async
|
|
447
|
+
async listOrgs(options) {
|
|
448
448
|
const { data, error, response } = await this.client.GET("/api/atlas/v2/orgs", options);
|
|
449
449
|
if (error) {
|
|
450
450
|
throw apiClientError_js_1.ApiClientError.fromError(response, error);
|
|
@@ -452,7 +452,7 @@ class ApiClient {
|
|
|
452
452
|
return data;
|
|
453
453
|
}
|
|
454
454
|
// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
|
|
455
|
-
async
|
|
455
|
+
async getOrgGroups(options) {
|
|
456
456
|
const { data, error, response } = await this.client.GET("/api/atlas/v2/orgs/{orgId}/groups", options);
|
|
457
457
|
if (error) {
|
|
458
458
|
throw apiClientError_js_1.ApiClientError.fromError(response, error);
|