Skip to content

MCP 服务器

添加本地和远程 MCP 工具。

你可以使用 模型上下文协议(Model Context Protocol,简称 MCP)向 OpenCode 添加外部工具。OpenCode 支持本地和远程服务器。

一旦添加,MCP 工具将与内置工具一起自动提供给 LLM 使用。


注意事项

当你使用 MCP 服务器时,它会增加上下文。如果你有很多工具,这会迅速累积。因此我们建议谨慎选择使用哪些 MCP 服务器。

某些 MCP 服务器,例如 GitHub MCP 服务器,往往会添加大量令牌,很容易超出上下文限制。


启用

你可以在 OpenCode 配置mcp 项下定义 MCP 服务器。为每个 MCP 添加一个唯一的名称。在提示 LLM 时,你可以通过该名称引用该 MCP。

opencode.jsonc
{
"$schema": "https://opencode.ai/config.json",
"mcp": {
"name-of-mcp-server": {
// ...
"enabled": true,
},
"name-of-other-mcp-server": {
// ...
},
},
}

你也可以通过将 enabled 设置为 false 来禁用服务器。如果你想临时禁用某个服务器而不从配置中移除它,这很有用。


本地 MCP 服务器

通过将 MCP 对象中的 type 设置为 "local" 来添加本地 MCP 服务器。

opencode.jsonc
{
"$schema": "https://opencode.ai/config.json",
"mcp": {
"my-local-mcp-server": {
"type": "local",
// 或者 ["bun", "x", "my-mcp-command"]
"command": ["npx", "-y", "my-mcp-command"],
"enabled": true,
"environment": {
"MY_ENV_VAR": "my_env_var_value",
},
},
},
}

command 定义了如何启动本地 MCP 服务器。你也可以传入一组环境变量。

例如,以下是如何添加测试用的 @modelcontextprotocol/server-everything MCP 服务器。

opencode.jsonc
{
"$schema": "https://opencode.ai/config.json",
"mcp": {
"mcp_everything": {
"type": "local",
"command": ["npx", "-y", "@modelcontextprotocol/server-everything"],
},
},
}

配置好后,我就可以在提示词中添加 use the mcp_everything tool 来使用它。

use the mcp_everything tool to add the number 3 and 4

选项

以下是配置本地 MCP 服务器的所有选项。

选项类型必需描述
typeStringMCP 服务器连接类型,必须为 "local"
commandArray运行 MCP 服务器的命令和参数。
environmentObject运行服务器时要设置的环境变量。
enabledBoolean在启动时启用或禁用 MCP 服务器。
timeoutNumber从 MCP 服务器获取工具的超时时间(毫秒)。默认为 5000(5 秒)。

远程

通过将 type 设置为 "remote" 来添加远程 MCP 服务器。

opencode.json
{
"$schema": "https://opencode.ai/config.json",
"mcp": {
"my-remote-mcp": {
"type": "remote",
"url": "https://my-mcp-server.com",
"enabled": true,
"headers": {
"Authorization": "Bearer MY_API_KEY"
}
}
}
}

url 是远程 MCP 服务器的 URL,通过 headers 选项可以传入一个头部列表。


选项

选项类型是否必需描述
typeStringMCP 服务器连接类型,必须为 "remote"
urlString远程 MCP 服务器的 URL。
enabledBoolean启动时启用或禁用 MCP 服务器。
headersObject随请求发送的头部信息。
oauthObjectOAuth 身份验证配置。请参阅下面的 OAuth 部分。
timeoutNumber从 MCP 服务器获取工具的超时时间(毫秒)。默认为 5000(5 秒)。

OAuth

OpenCode 会自动处理远程 MCP 服务器的 OAuth 身份验证。当服务器需要身份验证时,OpenCode 会:

  1. 检测到 401 响应并启动 OAuth 流程
  2. 如果服务器支持,则使用动态客户端注册 (RFC 7591)
  3. 安全地存储令牌以供后续请求使用

自动配置

对于大多数启用了 OAuth 的 MCP 服务器,无需特殊配置。只需配置远程服务器:

opencode.json
{
"$schema": "https://opencode.ai/config.json",
"mcp": {
"my-oauth-server": {
"type": "remote",
"url": "https://mcp.example.com/mcp"
}
}
}

如果服务器需要身份验证,OpenCode 会在您首次尝试使用时提示您进行身份验证。如果不需要,您也可以通过 opencode mcp auth <server-name> 手动触发流程


预注册

如果您拥有来自 MCP 服务器提供商的客户端凭据,可以按如下方式配置:

opencode.json
{
"$schema": "https://opencode.ai/config.json",
"mcp": {
"my-oauth-server": {
"type": "remote",
"url": "https://mcp.example.com/mcp",
"oauth": {
"clientId": "{env:MY_MCP_CLIENT_ID}",
"clientSecret": "{env:MY_MCP_CLIENT_SECRET}",
"scope": "tools:read tools:execute"
}
}
}
}

身份验证

您可以手动触发身份验证或管理凭据。

对特定的 MCP 服务器进行身份验证:

Terminal window
opencode mcp auth my-oauth-server

列出所有 MCP 服务器及其身份验证状态:

Terminal window
opencode mcp list

移除存储的凭据:

Terminal window
opencode mcp logout my-oauth-server

mcp auth 命令将打开您的浏览器进行授权。授权后,OpenCode 会将令牌安全地存储在 ~/.local/share/opencode/mcp-auth.json 中。


禁用 OAuth

如果您想为某个服务器禁用自动 OAuth(例如,对于使用 API 密钥的服务器),请将 oauth 设置为 false

opencode.json
{
"$schema": "https://opencode.ai/config.json",
"mcp": {
"my-api-key-server": {
"type": "remote",
"url": "https://mcp.example.com/mcp",
"oauth": false,
"headers": {
"Authorization": "Bearer {env:MY_API_KEY}"
}
}
}
}

OAuth 选项

选项类型描述
oauthObject | falseOAuth 配置对象,或设为 false 以禁用 OAuth 自动检测。
clientIdStringOAuth 客户端 ID。如果未提供,将尝试动态客户端注册。
clientSecretStringOAuth 客户端密钥,如果授权服务器要求的话。
scopeString授权期间请求的 OAuth 作用域。

调试

如果远程 MCP 服务器身份验证失败,您可以使用以下命令诊断问题:

Terminal window
# 查看所有支持 OAuth 的服务器的身份验证状态
opencode mcp auth list
# 调试特定服务器的连接和 OAuth 流程
opencode mcp debug my-oauth-server

mcp debug 命令会显示当前的身份验证状态、测试 HTTP 连接性,并尝试 OAuth 发现流程。


管理

您的 MCP 在 OpenCode 中作为工具可用,与内置工具并列。因此,您可以像管理其他工具一样通过 OpenCode 配置来管理它们。


全局设置

这意味着您可以全局启用或禁用它们。

opencode.json
{
"$schema": "https://opencode.ai/config.json",
"mcp": {
"my-mcp-foo": {
"type": "local",
"command": ["bun", "x", "my-mcp-command-foo"]
},
"my-mcp-bar": {
"type": "local",
"command": ["bun", "x", "my-mcp-command-bar"]
}
},
"tools": {
"my-mcp-foo": false
}
}

我们也可以使用 glob 模式来禁用所有匹配的 MCP。

opencode.json
{
"$schema": "https://opencode.ai/config.json",
"mcp": {
"my-mcp-foo": {
"type": "local",
"command": ["bun", "x", "my-mcp-command-foo"]
},
"my-mcp-bar": {
"type": "local",
"command": ["bun", "x", "my-mcp-command-bar"]
}
},
"tools": {
"my-mcp*": false
}
}

这里我们使用 glob 模式 my-mcp* 来禁用所有 MCP。


按智能体设置

如果您有大量 MCP 服务器,您可能希望仅在每个智能体上启用它们,并在全局范围内禁用它们。要做到这一点:

  1. 全局将其作为工具禁用。
  2. 在您的 智能体配置 中,将 MCP 服务器作为工具启用。
opencode.json
{
"$schema": "https://opencode.ai/config.json",
"mcp": {
"my-mcp": {
"type": "local",
"command": ["bun", "x", "my-mcp-command"],
"enabled": true
}
},
"tools": {
"my-mcp*": false
},
"agent": {
"my-agent": {
"tools": {
"my-mcp*": true
}
}
}
}

Glob 模式

glob 模式使用简单的正则表达式通配模式:

  • * 匹配零个或多个任意字符(例如,"my-mcp*" 匹配 my-mcp_searchmy-mcp_list 等)
  • ? 精确匹配一个字符
  • 所有其他字符按字面意思匹配

示例

以下是一些常见 MCP 服务器的示例。如果你想为其他服务器添加文档,可以提交 PR。


Sentry

添加 Sentry MCP 服务器 来与你的 Sentry 项目和问题进行交互。

opencode.json
{
"$schema": "https://opencode.ai/config.json",
"mcp": {
"sentry": {
"type": "remote",
"url": "https://mcp.sentry.dev/mcp",
"oauth": {}
}
}
}

添加配置后,使用 Sentry 进行身份验证:

Terminal window
opencode mcp auth sentry

这将打开一个浏览器窗口以完成 OAuth 流程,并将 OpenCode 连接到你的 Sentry 账户。

身份验证成功后,你可以在提示词中使用 Sentry 工具来查询问题、项目和错误数据。

显示我项目中最新未解决的问题。use sentry

Context7

添加 Context7 MCP 服务器 来搜索文档。

opencode.json
{
"$schema": "https://opencode.ai/config.json",
"mcp": {
"context7": {
"type": "remote",
"url": "https://mcp.context7.com/mcp"
}
}
}

如果你已经注册了免费账户,可以使用你的 API 密钥并获得更高的速率限制。

opencode.json
{
"$schema": "https://opencode.ai/config.json",
"mcp": {
"context7": {
"type": "remote",
"url": "https://mcp.context7.com/mcp",
"headers": {
"CONTEXT7_API_KEY": "{env:CONTEXT7_API_KEY}"
}
}
}
}

这里我们假设你已经设置了 CONTEXT7_API_KEY 环境变量。

在你的提示词中添加 use context7 来使用 Context7 MCP 服务器。

配置一个 Cloudflare Worker 脚本,用于缓存 JSON API 响应五分钟。use context7

或者,你可以将类似的内容添加到你的 AGENTS.md 文件中。

AGENTS.md
当你需要搜索文档时,使用 `context7` 工具。

Grep by Vercel

添加 Grep by Vercel MCP 服务器,以便在 GitHub 上搜索代码片段。

opencode.json
{
"$schema": "https://opencode.ai/config.json",
"mcp": {
"gh_grep": {
"type": "remote",
"url": "https://mcp.grep.app"
}
}
}

由于我们将 MCP 服务器命名为 gh_grep,你可以在提示词中添加 use the gh_grep tool 来让 agent 使用它。

在 SST Astro 组件中设置自定义域名的正确方法是什么?use the gh_grep tool

或者,你可以将类似的内容添加到你的 AGENTS.md 文件中。

AGENTS.md
如果你不确定如何做某事,请使用 `gh_grep` 搜索 GitHub 上的代码示例。