Codewhale 文档
版本最新发布 v0.10.2 · 2026年10月24日本站文档描述的是已发布的 v0.10.2。更新日志 →

用 MCP 连接工具

MCP 服务器能为 Codewhale 带来更多工具——数据库、问题跟踪系统、浏览器等。你可以添加一个由 Codewhale 替你启动的本地服务器,也可以通过 URL 添加远程服务器。这些工具与内置工具走同一套审批流程。

添加服务器

codewhale mcp add git --command "uvx" --arg "mcp-server-git"
codewhale mcp add docs --url "https://example.com/mcp"
codewhale mcp list
codewhale mcp validate

--command 通过 stdio 启动本地服务器,每个参数用一个 --arg。--url 通过 Streamable HTTP 连接远程服务器,必要时回退到旧版 SSE。mcp validate 会检查配置文件以及你标记为必需的服务器。

在会话中,/mcp 会打开 MCP 管理器:显示每个服务器的状态、传输方式、超时设置、错误信息和已发现的工具。同样的操作在那里也能完成,例如 /mcp add stdio <name> <command> 和 /mcp add http <name> <url>。

注意: MCP 服务器以你的权限运行。只添加你信任的服务器,就像只安装你信任的程序一样。

登录远程服务器

使用 OAuth 的服务器,先用 URL 添加再登录。使用 bearer token 的服务器,把令牌放在环境变量里,而不是写进配置文件:

codewhale mcp login docs
codewhale mcp add tracker --url "https://example.com/mcp" --bearer-token-env-var TRACKER_TOKEN

显式设置的 Authorization 请求头始终优先:先应用配置中的请求头,其次是 bearer token 环境变量,最后才是已保存的 OAuth 登录。codewhale mcp logout <name> 会删除本机保存的登录信息;提供商那边的授权可能仍然有效,需要到提供商处撤销。

编辑配置文件

服务器配置保存在 ~/.codewhale/mcp.json,codewhale mcp init 会生成一个初始文件。其他客户端使用的 mcpServers 键同样可用,现成的配置可以直接粘贴进来。

{
  "servers": {
    "example": {
      "command": "node",
      "args": ["./path/to/your-mcp-server.js"],
      "env": {},
      "disabled": false
    }
  }
}

修改文件后,在会话中运行 /mcp reload 即可,无需重启。服务器只在某个回合需要它的工具时才启动;如果希望它在启动时就连接,把它标记为 "required": true。

找到这些工具

每个工具在模型眼中的名字是 mcp_<server>_<tool>:名为 git 的服务器提供的 status 工具,就叫 mcp_git_status。codewhale mcp tools <server> 会列出某个服务器提供的工具。连接失败或已禁用的服务器,其工具永远不会显示为可用。

MCP 工具遵循你的审批设置:在策略允许时,列出和读取服务器的资源与提示词无需确认;有副作用的工具会先征求你的同意。Full Access 也不会绕过仓库规则或托管策略。

把 Codewhale 作为 MCP 服务器运行

其他 MCP 客户端可以把 Codewhale 作为工具服务器。默认仅暴露只读的 file_read 和 search 工具。

codewhale mcp add-self
codewhale mcp tools codewhale

add-self 注册通过 stdio 运行的 codewhale serve --mcp;codewhale mcp-server 是等价入口。除非操作者在服务器配置中明确允许,否则不会提供写入工具。Runtime API HTTP 是单独的传输方式。

用代码模式组合工具调用(实验性)

代码模式让模型写一段简短的 JavaScript 程序,在其中调用多个工具、循环和筛选结果,而不必把每次调用都作为单独的一步。只有程序的最终结果会返回给模型,长时间的查找因此更紧凑。它默认开启——execute_tools 从第一条请求起就会提供——MCP 和插件工具与内置工具一样可以在程序中组合调用。关闭它并不会移除代码模式:execute_tools 会恢复为延迟加载,模型仍可通过 tool_search 找到它。要关闭它,可以只在一次会话中关闭,也可以在配置中关闭:

codewhale --disable code_mode

# ~/.codewhale/config.toml
[features]
code_mode = false
  • 程序中的嵌套调用——原生工具、MCP 和插件工具都一样——与直接调用走同一道关卡:允许/拒绝名单、ask 规则和审查照常生效。需要审批的调用会弹出常规审批卡片并暂停程序;允许后程序继续,拒绝只让该次调用失败。批准程序本身不会获得任何权限。
  • MCP 调用经由会话的 MCP 连接池执行,插件工具也可以像内置工具一样在程序中调用。
  • 每个程序的上限:50 次嵌套调用、同时最多 4 次、返回 16 KiB。程序没有固定的 30 秒上限:它使用当前回合剩余的墙钟时间,除非设置了 [tui].turn_wall_clock_secs,否则不受限制。
  • Plan 模式下不能使用代码模式。

下一步

在事件发生时运行命令

在工具调用执行前检查或改写它,MCP 工具也不例外。

设置模式与审批

决定哪些 MCP 调用需要你批准。

用 Runtime API 自动化

通过 HTTP 从你自己的应用或脚本驱动 Codewhale。