对于 AI 代理:可在 https://www.mongodb.com/zh-cn/docs/llms.txt 获取文档索引—通过在任何 URL 路径后添加 .md 可获取所有页面的 Markdown 版本。
Docs 菜单

MongoDB MCP 服务器工具

MongoDB MCP 服务器允许您使用来自支持MCP的AI客户端的自然语言查询与MongoDB集群进行交互。本页介绍 MCP 服务器工具。

MongoDB MCP 服务器提供以下工具类别:

  • Atlas工具,对Atlas系统资源(如组织、项目、集群、数据库用户帐户)执行操作并检索性能建议。

  • 本地Atlas工具,允许您列出、连接、创建和删除本地Atlas部署。

  • 助手工具,可以在 MongoDB Assistant 知识库中搜索官方文档和精选指导。

  • 数据库工具,执行插入、更新和删除文档以及运行查询和聚合管道等操作。

仅当您按照MongoDB MCP 服务器配置中所示设立 Atlas API 凭证后,Atlas 工具才可用。

下表描述了Atlas工具:

MCP Server Atlas工具名称
说明

atlas-list-orgs

返回Atlas组织列表。

atlas-list-projects

返回Atlas项目列表。

atlas-create-project

创建新的Atlas项目。

atlas-list-clusters

返回Atlas集群列表。

atlas-inspect-cluster

返回有关特定Atlas 集群的信息。

atlas-create-free-cluster

创建一个免费的Atlas 集群。

atlas-connect-cluster

使用配置的服务帐户连接到Atlas 集群。

如果配置 MCP服务器时未指定连接字符串,则此工具将创建一个具有随机密码的临时数据库用户来建立连接。有关详细信息,请参阅工具详情。

atlas-upgrade-cluster

支持以下Atlas 集群升级:

  • 自由灵活

  • 免费提供给 M10

  • Flex 至 M10

您可以选择指定目标 regionprovider

atlas-create-cluster

创建具有 M10–M80实例大小的专用Atlas 集群。支持一到三个地区的副本集和单分片集群类型。

  • clusterType 默认为 REPLICASETSHARDED 集群仅单分片,需要 M30 或更高版本。

  • regions 按优先级顺序最多接受三个Atlas地区。第一个地区具有最高优先级并拥有主节点 (primary node in the replica set)节点。

  • encryptionAtRestProvider 选择客户托管的密钥提供商进行静态加密。密钥提供商必须在项目中已有有效的静态加密配置。

  • 计算自动扩展默认启用。磁盘自动扩展始终启用。

  • 该工具立即返回。使用 atlas-inspect-cluster 进行拉取,直到集群状态达到 IDLE

atlas-pause-resume-cluster

暂停或恢复专用(M10+)Atlas 集群。免费和 Flex 集群不能暂停。

  • 暂停:使集群无法连接,并停止计算费用。集群必须处于 IDLE 省/市/自治区。

  • 恢复:重新启动已暂停的集群。使用 atlas-inspect-cluster 进行轮询,直到集群省/市/自治区达到 IDLE

atlas-inspect-access-list

返回有关可以访问权限Atlas 集群的IPCIDR范围的信息。

atlas-create-access-list

为Atlas 集群配置IPCIDR访问权限列表。

atlas-list-db-users

返回Atlas数据库用户的列表。

atlas-create-db-user

创建Atlas数据库用户。

atlas-list-alerts

返回Atlas项目的警报列表。

atlas-get-performance-advisor

返回 Performance Advisor 针对 Atlas 集群的建议。支持对建议索引、删除索引建议、慢查询日志和模式建议的操作。需要 Project Read Only 或更高访问权限。

要学习;了解更多信息,请参阅Performance Advisor工具。

atlas-streams-discover

返回有关Atlas Stream Processing工作区、处理器、公共连接或 privatelink 网络连接的信息。

atlas-streams-build

创建Atlas Stream Processing工作区、处理器、公共连接或 privatelink 网络连接。

atlas-streams-manage

管理Atlas Stream Processing工作区、处理器或公共连接。MongoDB MCP 服务器可以:

  • 启动、停止或更新处理器。

  • 更新工作区。

  • 更新公共连接。

  • 接受或拒绝 PrivateLink 网络连接。

atlas-streams-teardown

删除Atlas Stream Processing工作区、处理器、公共连接或 privatelink 网络连接。

您可以将 MCP 服务器与本地 Atlas 部署一起使用。要将 MCP 服务器工具用于本地Atlas部署,您必须安装Docker。有关本地Atlas部署的介绍,请参阅创建本地Atlas部署。

下表描述了本地Atlas工具:

MCP 服务器本地Atlas工具名称
说明

atlas-local-list-deployments

列出本地Atlas部署。

atlas-local-create-deployment

创建本地Atlas部署。要运行此工具,必须禁用只读模式。

atlas-local-connect-deployment

连接到本地Atlas部署。

atlas-local-delete-deployment

删除本地Atlas部署。要运行此工具,必须禁用只读模式。

有关运行本地Atlas工具的示例,请参阅本地Atlas部署。

辅助工具可以让 AI 客户端访问 MongoDB Assistant 知识库,其中包括官方 MongoDB 文档、精选的专家指导以及 MongoDB 提供的其他资源。这些工具可以让 AI 客户端检索准确的版本特定 MongoDB 信息,而不仅仅依赖其培训数据。

下表描述了助手工具:

MCP 服务器协助工具名称
说明

list-knowledge-sources

列出 MongoDB Assistant 知识库中的可用数据源。使用此功能查看可用数据源,或查找可在 search-knowledge 中使用的搜索过滤器参数。

search-knowledge

在 MongoDB Assistant 知识库中搜索信息。知识库包括官方文档、精选的专家指导以及 MongoDB 提供的其他资源。支持按数据源和版本进行过滤器。

下表描述了数据库工具:

MCP 服务器数据库工具名称
说明

connect

连接到MongoDB 集群。

find

运行MongoDB 数据库查询。

aggregate

运行MongoDB聚合管道。

count

返回集合中的文档数。

explain

返回统计信息,描述查询优化器为评估方法选择的获胜计划的执行情况。

insert-many

将文档添加到集合。

如果您在 MCP 配置中指定了 Voyage AI API密钥,服务器可以自动从文本生成向量嵌入,并将其包含在插入的文档中。

create-index

在集合上创建索引。此工具支持创建向量搜索索引。

drop-index

删除所提供数据库和集合的索引。此工具支持删除向量搜索索引。

update-one

修改集合中的单个文档。

update-many

修改集合中的多个文档。

rename-collection

更改集合的名称。

create-collection

创建一个新集合。

delete-many

从集合中删除文档。

drop-collection

从数据库中删除集合。

drop-database

删除数据库。

list-databases

返回通过当前连接可用的所有数据库的列表。

list-collections

返回数据库中的集合列表。

collection-indexes

collection-schema

返回集合模式信息。

collection-storage-size

返回集合大小(以 MB 为单位)。

db-stats

返回数据库统计信息。

export

将查询或聚合管道的结果以JSON格式保存到运行 MCP 服务器的计算机上的文件中。还可以通过AI客户端应用程序中的 exported-data资源获取结果。

mongodb-logs

返回最近的日志 mongod 事件。

switch-connection

切换到不同的MongoDB连接。

有关特定 MCP 工具的更多信息,请参阅以下部分。

MongoDB MCP 服务器支持MongoDB 向量搜索。您可以创建和管理向量搜索索引、生成嵌入以及通过自然语言提示运行语义搜索查询。下表总结了主要功能。

用例(Use Case)
示例提示
相关工具

管理索引

Create a vector search index on the sample_db database and products collection

Show me all vector search indexes on the products collection

Drop the vector search index named vector_index

create-index
collection-indexes
drop-index

重要提示:要更新向量搜索索引,请删除现有索引并创建新索引。

插入具有自动嵌入功能的文档

Insert these documents into the products collection and embed their descriptions

insert-many

向量搜索查询

Search for documents semantically similar to this description

Find me related products filtered by price range

aggregate

使用以下资源学习;了解更多信息:

您可以使用 MongoDB MCP 服务器与 Atlas Stream Processing 资源进行交互。Atlas Stream Processing 使您能够使用 Atlas 数据库中使用的相同聚合操作来连续读取、写入和转换数据流。您将为所有运行的处理器支付费用。

有关更多信息,请参阅Atlas Stream Processing。

MongoDB MCP Server 支持两种独立的向量嵌入生成机制:

  • MCP 服务器嵌入生成:在将文档发送到MongoDB之前,MCP 服务器使用 Voyage AI在客户端生成嵌入。这需要 Voyage AI API密钥。

  • MongoDB自动嵌入:插入或更新文档时, MongoDB会在服务器端自动生成嵌入。要学习;了解更多信息,请参阅MongoDB自动嵌入。

这些机制独立工作,可以根据您的使用案例一起或单独使用。

如果您使用 Voyage AI API密钥 配置 MCP 服务器,服务器可以通过以下方式自动生成嵌入:

  • 为文档生成嵌入内容:使用 insert-many 工具时在文档中嵌入文本字段。

  • 为查询生成嵌入:使用 aggregate 工具运行向量搜索搜索查询时嵌入搜索查询。具体来说,服务器为$vectorSearch聚合查询中的 queryVector 参数生成嵌入。

MCP 服务器支持以下 Voyage AI嵌入模型:

  • voyage-3-large

  • voyage-3.5

  • voyage-3.5-lite

  • voyage-code-3

要学习;了解有关 Voyage AI模型的更多信息,请参阅 Voyage AI文档。

注意

默认下, MongoDB MCP 服务器 会验证具有向量搜索索引的字段是否包含有效的向量嵌入,以防止破坏向量搜索索引。要禁用此行为,请将 disableEmbeddingsValidation 选项设立为 true。要学习;了解更多信息,请参阅 voyageApiKey。

重要

向量搜索索引中的自动嵌入作为预览功能仅适用于MongoDB Community Edition v8.2 及更高版本。在预览期间,功能和相应的文档可能随时更改。

插入或更新文档时, MongoDB还可以在服务器端自动生成嵌入。这种方法不需要在 MCP 配置中使用 Voyage AI API密钥,因为嵌入生成发生在MongoDB中。

MongoDB MCP 服务器支持通过自动嵌入来管理向量搜索索引,这会自动为文档生成嵌入。您可以通过自然语言提示创建、删除和检查具有自动嵌入功能的向量搜索索引。下表总结了主要功能。

要学习;了解更多信息,请参阅自动嵌入。

用例(Use Case)
相关工具
示例提示

管理索引

create-index

collection-indexes

drop-index

“使用 voyage-4-large 模型在 'mflix.movies'命名空间中的 'plot'字段上创建自动嵌入向量搜索索引。”

插入具有嵌入的数据

insert-many

“使用以下字段插入这些文档并自动生成嵌入...”

使用嵌入进行查询

aggregate

“使用‘情节’字段上的自动嵌入索引对 mflix.movies 运行向量搜索查询。”

MongoDB MCP 服务器支持预过滤向量搜索查询。要学习;了解更多信息,请参阅预过滤。

MCP服务器不支持向量搜索索引的 quantization字段。

atlas-get-performance-advisor 工具允许您通过自然语言查询访问Performance Advisor的建议。该工具通过分析慢速查询并提出改进建议,帮助您发现性能优化机会。

执行慢查询分析时, MongoDB MCP 服务器会检索慢查询示例,上限为 50 个查询。该示例最多包含 50 个符合提示中任何指定条件的最新慢速查询,以确保最佳性能和响应时间。

注意

此工具需要 Project Read Only 访问权限或更高权限以及 M10+集群。使用 --readonly 标志运行此工具。

Project Read Only 指分配给您的服务帐户的 Atlas 项目级角色,而不是数据库角色。

用例(Use Case)
示例提示
Performance Advisor操作

分析慢速查询

Show me my slow queries

What is slowing down my cluster?

Show me queries that are longer than 5 seconds

Show me slow writes in the website.users namespace

索引建议

Are there any indexes I should create to improve performance?

What indexes do you recommend I drop?

模式建议

Show schema recommendations for my cluster

Help me optimize my database schema

有关详细的使用示例和示例输出,请参阅性能优化。

如果配置 MCP服务器时未指定Atlas 集群的连接字符串,则atlas-connect-cluster工具将使用配置的Atlas API服务帐户凭证创建临时数据库用户并建立与集群的连接。

临时数据库用户具有以下特征:

  • 随机生成的用户名和密码。

  • 默认下,在 4 小时后过期。

  • 根据您配置 MCP 服务器的方式分配的角色:

注意

MongoDB MCP 服务器仅将用户凭证存储在内存中,从不返回或在 LLM 上下文中公开凭证。

要禁用特定工具并将 MCP 服务器限制为只读模式,请参阅MongoDB MCP 服务器配置。

要查看一些 MCP Server 示例自然语言提示,请参阅MongoDB MCP Server 使用示例。