开启
Docker Compose 安装程序默认关闭此端点。请在kodus-installer 目录的 .env 中添加以下配置:
docker compose up -d --no-deps api 以应用新变量。
Helm Chart 默认启用此端点。要关闭它,请在 values 文件中将 global.config.API_MCP_SERVER_ENABLED 设为 "false",然后运行 helm upgrade。
关闭时,API 不会提供 /mcp。该路由是 API 主机上的 POST /mcp,因此反向代理必须转发它。参见反向代理。
连接客户端
将客户端连接到自托管实例的 API 端点https://<your-api-host>/mcp。服务器使用 Streamable HTTP。
- 打开 Organization → CLI keys,生成一个密钥并复制。只有组织所有者可以生成密钥。参见 CLI 密钥。
- 配置客户端,使其在调用工具时通过以下任一请求头发送密钥。
kodus-api.example.com 替换为您的 API 主机名,然后列出工具。此发现请求无需密钥。
- 一个密钥属于一个团队。指向其他团队的
teamId参数会被拒绝,省略teamId时会根据密钥自动填入。 - 大多数工具接受
organizationId参数。它必须是您组织的 ID,其他值会被拒绝。 initialize、tools/list和ping无需密钥即可使用。其他任何调用都需要有效的密钥,缺失、无效或已撤销的密钥会返回401。
工具
代码库和拉取请求
Kody Issues
Kody Rules 和记忆
管理规则和记忆
KODUS_CREATE_KODY_RULE、KODUS_UPDATE_KODY_RULE、KODUS_DELETE_KODY_RULE 和 KODUS_CREATE_MEMORY 需要密钥具有 kodyRules:manage 能力。在 Organization → CLI keys 中,点击该密钥上的 Configure 并开启 Allow Kody Rules management via CLI。没有它,这些工具会返回错误结果(isError: true),提示该密钥无权管理 Kody Rules。其他工具不需要任何能力。
- 通过该服务器创建的规则显示 MCP/Agent 来源,并在 Pending review 中等待,直到有人批准。
- 只有在 Kody knowledge approval 开启时,记忆才会在那里等待。
- 启用集中配置后,创建、更改或删除规则或记忆会改为在配置代码库上打开一个拉取请求。
限制
- 仅支持
POST。 - 无状态。服务器在请求之间不保留会话,也不返回
Mcp-Session-Id。 - 除了对
POST的响应之外,它不会向客户端发送任何内容。