中文
文档
MCP 服务器

MCP 服务器

添加本地和远程 MCP 工具。

你可以使用 Model Context Protocol(MCP)为 OpenCode 添加外部工具。OpenCode 支持本地和远程服务器。

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


注意事项

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

MCP 服务器会增加你的上下文,所以你需要谨慎选择启用哪些服务器。

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


启用

你可以在 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 来禁用服务器。如果你想临时禁用服务器而不从配置中删除它,这很有用。


覆盖远程默认值

组织可以通过其 .well-known/opencode 端点提供默认的 MCP 服务器。这些服务器可能默认禁用,允许用户选择启用他们需要的服务器。

要从组织的远程配置中启用特定服务器,请在本地配置中添加 enabled: true

opencode.json
{
  "$schema": "https://opencode.ai/config.json",
  "mcp": {
    "jira": {
      "type": "remote",
      "url": "https://jira.example.com/mcp",
      "enabled": true
    }
  }
}

你的本地配置值会覆盖远程默认值。详情请参阅配置优先级


本地

通过在 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 (opens in a new tab) 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 会:

  • 检测 401 响应并启动 OAuth 流程
  • 如果服务器支持,使用动态客户端注册(RFC 7591)
  • 安全存储 token 以供后续请求使用

自动

对于大多数启用 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 服务器进行认证:

opencode mcp auth my-oauth-server

列出所有 MCP 服务器及其认证状态:

opencode mcp list

删除存储的凭据:

opencode mcp logout my-oauth-server

mcp auth 命令会打开浏览器进行授权。授权后,OpenCode 会将 token 安全存储在 ~/.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 服务器认证失败,你可以使用以下命令诊断问题:

# 查看所有支持 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 服务器,你可能希望只在每个代理中启用它们,而全局禁用。要做到这一点:

  • 全局禁用它作为工具。
  • 在你的代理配置中,将 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 服务器工具以服务器名称作为前缀注册,因此要禁用某个服务器的所有工具,只需使用:

"mymcpservername_*": false

示例

以下是一些常见 MCP 服务器的示例。如果你想记录其他服务器,可以提交 PR。


Sentry

添加 Sentry MCP 服务器 (opens in a new tab) 来与你的 Sentry 项目和问题交互。

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

添加配置后,使用 Sentry 进行认证:

opencode mcp auth sentry

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

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

Show me the latest unresolved issues in my project. use sentry

Context7

添加 Context7 MCP 服务器 (opens in a new tab) 来搜索文档。

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 服务器。

Configure a Cloudflare Worker script to cache JSON API responses for five minutes. use context7

或者,你可以在 AGENTS.md 中添加类似这样的内容。

AGENTS.md
When you need to search docs, use `context7` tools.

Grep by Vercel

添加 Grep by Vercel (opens in a new tab) 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 来让代理使用它。

What's the right way to set a custom domain in an SST Astro component? use the gh_grep tool

或者,你可以在 AGENTS.md 中添加类似这样的内容。

AGENTS.md
If you are unsure how to do something, use `gh_grep` to search code examples from GitHub.