Docs 菜单
Docs 主页
/ /

Visual Studio Code 设置

本文档列出了VS Code扩展的可配置设置。

要配置VS Code扩展设置,请执行以下操作:

1
操作系统
方法
操作

Any

Visual Studio Code 菜单

File / Code > Preferences > Settings

macOS

键盘快捷键

Command + ,

Windows 和 Linux

键盘快捷键

Ctrl + ,

2

显示VS Code扩展扩展设置。 您所做的更改会自动保存。

下表列出了VS Code扩展的可用设置:

设置
说明
默认

Shell

要使用的 MongoDB Shell。选择以下任一项:

  • mongo (旧版 MongoDB Shell),或者

  • mongosh (新的 MongoDB Shell)

要启动所选的 MongoDB Shell,您必须执行以下操作:

  • 安装要使用的 Shell,然后

  • 配置设备的 PATH 环境变量,以包含 Shell 二进制文件的文件路径。

若要安装新版本的 MongoDB Shell,则需要更新 PATH 变量,以引用新版本。

  • 要安装旧版 mongo shell ,请参阅mongo shell 。

  • 要安装 mongosh Shell 并获取有关配置 PATH 变量的说明,请参阅安装 MongoDB Shell

mongosh

Show

如果启用,则会在 Visual Studio Code 左侧导航面板中显示 MongoDB 视图。

已启用

Max Number of Problems

VS Code扩展将在 Visual Studio Code Problems视图中生成的最大问题数。

100

Trace: Server

MongoDB 语言服务器日志记录设置。

通过项目的 settings.json 文件中的 mongodbLanguageServer.trace.server 属性编辑此设置。

mongodbLanguageServer.trace.server 对象中,您可以指定:

  • format

  • verbosity

Output(输出)视图的下拉菜单中选择 MongoDB Language Server,或者使用 Language Server Protocol Inspector,即可查看输出日志。

{
"format": "json",
"verbosity": "verbose"
}

Confirm Run All

如果启用,则在 Playground 中运行命令之前显示确认消息。

已启用

Default Connection Saving Location

设置是否保存新连接,以及将其保存到什么位置。

您可以选择:

设置
说明

Global

在 VS Code 中全局保存您的连接,这样就可以从任何工作区访问它。

Workspace

将连接保存在您的工作区中。您将无法从另外的工作区访问该连接。

Session

仅保存此 VS Code 会话的连接。您关闭 VS Code 时,连接将丢失。

Global

Hide Option To Choose Where To Save New Connections

如果禁用,系统将提示您选择保存每个新连接的位置。

如果启用,则新连接会自动保存到 Default Connection Saving Location(默认链接保存位置),而不会出现提示。

已启用

Default Limit

查看集合中的文档时要获取的文档数。不影响 Playground 运行。

10

Preset Connections

指定预设的连接列表。使用此设置可在工作区或全局范围内股票连接配置。

编辑项目 settings.json文件中的 mdb.presetConnection属性。

mdb.presetConnections 对象中,您可以指定:

  • 用于连接的 name

  • 部署的 connectionString

警告:请勿在此设置中存储敏感凭证。连接字符串以纯文本形式存储,因此可以轻松访问。

[
{
"name": "Preset Connection",
"connectionString": "mongodb://localhost:27017"
}
]

Send Telemetry

如果启用,则允许集合匿名诊断和使用情况遥测数据,以帮助改进VS Code扩展。

已启用

Use Default Template For Playground

如果启用,Playground 文件会加载包含样本命令的模板。

如果禁用,Playground 文件将使用空的 Playground 编辑器加载。

已启用

Show Overview Page After Install

如果启用, VS Code扩展会在安装后显示概述页面,以帮助你入门。

如果禁用, VS Code扩展在安装后不会显示概述页面。这在已经设立好工作环境的容器化环境(例如 GitHub Codespaces)中非常有用。在这些环境中,您无需在每次创建工作区时都查看概述页面。

已启用

Use Sample Docs in Copilot

启用后,适用于Github Copilot 的MongoDB扩展可以使用 /query 命令发送示例字段值。

残疾人

MCP: Server

控制当VS Code打开并连接到活动连接时, MongoDB MCP服务器是否自动启动。

  • 如果设立为 prompt,则每次在VS Code中成功连接时,扩展都会请求权限。

  • 如果设立为 autoStartEnabled,则服务器会在VS Code打开时自动启动。不显示任何通知。

  • 如果设立为autoStartDisabled ,则服务器不会自动启动。不显示任何通知。必须使用“启动 MCP 服务器”命令手动启动服务器。

服务器首次启动时, VS Code会显示一条通知,询问您是要启用还是禁用自动启动。您的选择会更新此设置。

当 MCP服务器未运行时,使用MongoDB: Start MCP Server 命令立即启动 MCP服务器。

prompt

MCP: Api Base URL

如果您使用的是自定义Atlas部署,请指定启用Atlas MCP 工具的MongoDB MCP服务器所使用的API URL 。

https://cloud.mongodb.com/

MCP: Api Client ID

用于根据Atlas API进行身份验证的Atlas API客户端ID 。使用服务帐户以编程方式访问权限Atlas API。在MongoDB MCP服务器中启用Atlas工具时需要。 安全地存储您的ID ,不要将其提交给版本控制。

要学习;了解更多信息,请参阅使用Atlas API凭证进行连接。

MCP: Api Client Secret

用于根据Atlas API进行身份验证的Atlas API客户端密钥。使用服务帐户以编程方式访问权限Atlas API。在MongoDB MCP服务器中启用Atlas工具时需要。 安全地存储此内容,并且不提交版本控制。

要学习;了解更多信息,请参阅使用Atlas API凭证进行连接。

MCP: Disabled Tools

使用MongoDB MCP服务器时要禁用的工具名称、操作类型(createupdatedeletereadmetadata)或类别(atlasmongodb)。

MCP Export Cleanup Interval Ms

MongoDB MCP服务器运行导出清理进程以删除过期文件的频率(以毫秒为单位)。默认值为 2 分钟(120000 毫秒)。

120000

MCP Exports Path

使用导出工具时, MongoDB MCP服务器导出数据的目录。确保该路径可用于写入,或将此设置留空以使用基于操作系统的默认路径。

默认路径:

  • Windows: %LOCALAPPDATA%\mongodb\mongodb-mcp\exports

  • macOS 和Linux: ~/.mongodb/mongodb-mcp/exports

MCP Export Timeout Ms

在MongoDB MCP服务器终止导出操作之前,该操作可以运行的最长时间(以毫秒为单位)。默认值为 5 分钟(300000 毫秒)。

300000

MCP Index Check

启用后, MongoDB MCP服务器强制查询操作必须使用索引,并拒绝执行集合扫描的查询。这有助于防止生产环境中出现性能问题。

残疾人

MCP: Read Only

启用后, MongoDB MCP服务器仅允许读取、连接和元数据操作类型。创建、更新和删除操作已禁用。

已启用

后退

命令

在此页面上