文档

Coroid 作为 MCP 服务器

连接 Hermes、Codex、Claude Code、Cursor 或其他 MCP 客户端,通过受管控的工具与 Coroid 协同工作。

Coroid 会暴露一个远程的 Model Context Protocol(MCP)服务器。Hermes、Codex、Claude Code 或 Cursor 等外部助手或智能体,可通过该服务器与 Coroid 协作,使用的正是聊天助手所用的同一套受管控的工具注册表。

在下方进行配置:设置 → 连接 → Coroid MCP 服务器,相关内容涵盖概览、客户端设置、访问令牌、审批和自动化策略。

端点

MCP 服务器运行在 API 网关上,地址如下:

https://api.coroid.ai/mcp

传输协议为无状态的 Streamable HTTP。可通过 OAuth 或个人访问令牌进行身份验证。

已启用的功能

Coroid 会分阶段为所有组织开启 MCP 功能。

功能在 coroid.ai 上
OAuth 登录已启用
读取工具已启用
个人访问令牌已启用
用于创建、修改、运行或交付工作的工具已启用
管理工具,包括组织设置尚未启用

某功能未启用时,客户端无法看到其对应的工具,且 Coroid 会拒绝针对这些工具的调用请求。本页其余内容将介绍完整的功能集。

连接客户端

若客户端支持 OAuth,请使用该方式。您可在浏览器中批准连接请求,且随时可撤销权限。访问令牌的有效期为 15 分钟,刷新令牌的有效期为 30 天,每次刷新都会替换原有的刷新令牌。

客户端在连接时会请求相应的权限范围。批准前,您可查看这些权限范围,并选择客户端能否访问所有项目还是仅部分项目。不请求任何权限范围的客户端仅拥有读取权限,因此请根据需求申请对应权限范围,正如 Codex 示例所示。

Hermes

hermes mcp add coroid --url https://api.coroid.ai/mcp --auth oauth
hermes mcp login coroid
hermes mcp test coroid

也可使用访问令牌:

hermes mcp add coroid --url https://api.coroid.ai/mcp --auth header

当 Hermes 请求令牌时,将其提供给它。请将令牌存储在 Hermes 的凭证库中,而非配置文件内。

Codex

codex mcp add coroid --url https://api.coroid.ai/mcp
codex mcp login coroid --scopes mcp.read,mcp.work.write,mcp.execute,mcp.delivery

也可使用访问令牌:

export COROID_MCP_TOKEN="cmp_pat_…"
codex mcp add coroid --url https://api.coroid.ai/mcp --bearer-token-env-var COROID_MCP_TOKEN

Claude Code

claude mcp add --transport http --scope user coroid https://api.coroid.ai/mcp
/mcp

先在终端中执行第一条命令,随后在 Claude Code 中输入第二条命令,选择 coroid 并在浏览器中完成登录。

也可使用访问令牌:

export COROID_MCP_TOKEN="cmp_pat_…"
claude mcp add --transport http --scope user --header "Authorization: Bearer $COROID_MCP_TOKEN" coroid https://api.coroid.ai/mcp

Cursor

将 Coroid 添加到~/.cursor/mcp.json,或添加到.cursor/mcp.json中的代码仓库 以便与所有相关开发人员共享该配置:

{
  "mcpServers": {
    "coroid": {
      "url": "https://api.coroid.ai/mcp"
    }
  }
}

Cursor 通过 OAuth 登录:当系统请求授权时,请在浏览器中批准连接。请在该页面上检查权限范围,因为没有写入权限的连接仅能进行读取操作。

也可使用访问令牌:

{
  "mcpServers": {
    "coroid": {
      "url": "https://api.coroid.ai/mcp",
      "headers": {
        "Authorization": "Bearer ${env:COROID_MCP_TOKEN}"
      }
    }
  }
}

设置COROID_MCP_TOKEN于 Cursor 启动时所依赖的环境中。.cursor/mcp.json代码仓库中的会被一并提交,因此请将该变量放在此处,切勿存放令牌。

其他客户端

任何支持通过 Streamable HTTP 连接远程 MCP 服务器的客户端均可接入。Coroid 会为该端点发布 OAuth 元数据,并支持基于 PKCE 的动态客户端注册。不支持 OAuth 的客户端可在以下标头中传入访问令牌作为承载令牌:Authorization。

智能体执行任何更改前,请先让其列出 Coroid 的工具,并读取该资源:coroid://context。它会显示智能体的身份、所拥有的权限范围和可访问的项目。

访问令牌

令牌的创建和管理均在访问令牌中进行。与其他所有凭证一样,令牌仅会显示一次,此后便不会再返回给使用者。

建议为每个客户端单独签发令牌,而非共享同一个令牌。这样撤销单个客户端的访问权限时,只会影响到该客户端,而不会导致所有用户都无法使用。

令牌的权限等同于其创建者,且只有登录门户的用户才能创建令牌。每个令牌都有专属的权限范围,有效期为 30 天、90 天或 365 天,可访问所有项目或仅限指定的项目。所有者还可为其绑定自动化策略。所有令牌均以相同前缀开头:cmp_pat_。

请将令牌存储在客户端的环境或凭证库中,切勿将其存入代码仓库或提示词中。

权限范围与角色

权限范围决定了连接的可用权限。您在组织中的角色设定了权限上限:工具需要同时具备对应的权限范围和最低角色要求。Coroid 会在每次调用时校验您当前的角色,因此连接不会保留您已失去的权限。

权限范围可解锁的功能最低角色要求
mcp.read读取项目、任务、计划、迭代、报告、依赖关系、产能数据、智能体运行记录、工厂流水线、推广活动和版本发布信息审核员
mcp.work.write创建和修改任务、计划、迭代、依赖关系和报告成员
mcp.execute启动、停止、重试、暂停、恢复和取消工作成员
mcp.delivery审批计划、结束迭代、 promotions、通道验证以及版本发布成员
mcp.projects.admin创建、更新、归档和恢复项目,以及版本号管理管理员
mcp.schedules.admin读取、创建、更新、触发和删除日程安排管理员
mcp.integrations.admin读取、测试、启用或禁用以及删除集成管理员
mcp.secrets.write创建存储凭证的集成所有者
mcp.organization.admin成员、邀请、组织资料和组织设置所有者
mcp.billing.read预留字段。目前尚无工具使用此项功能—
mcp.billing.write预留字段。目前尚无工具使用此项功能所有者

仅管理员或所有者才能授予最低权限等级为“管理员”的权限范围;仅所有者才能授予最低权限等级为“所有者”的权限范围。

仅限定于部分项目的连接无法访问其他项目中的任何内容,即使是通过任务、计划、迭代、报告或版本的ID也无法访问;此类连接也无法使用组织级工具,例如以下工具:list_plans、get_capacity_dashboard。

工具

客户端仅会列出已启用且符合您的权限范围和角色要求的工具。审批列说明了调用工具时的处理方式:

审批处理方式
无工具会立即运行
策略除非有自动化策略覆盖,否则调用请求需等待审批
始终调用请求始终需要所有者或管理员审批后方可执行

读取

这些工具需要“审核员”角色及对应的权限范围:mcp.read。它们均无需审批。

区域工具
项目list_projects、get_project、get_project_dependencies、list_project_branches
任务list_tasks、get_task、get_workflow_status、get_execution_status、check_task_can_start
计划list_plans、get_plan、get_plan_progress、list_plan_tasks
迭代list_sprints、get_sprint、get_sprint_status
依赖项analyze_dependencies、get_dependency_graph、get_global_dependency_graph、get_cross_project_blockers
报告list_reports、get_report、export_report、explain_report_execution、list_report_folders、list_report_subscriptions、list_report_templates
产能与活动get_capacity_dashboard、get_queue_eta、get_mission_control_activity、get_global_execution_stats、get_global_execution_actions、list_global_execution_runs
代理运行list_agent_executions、get_agent_execution、get_agent_execution_state、get_execution_conversation、list_tool_executions
Factory通道与promotionslist_factory_lanes、get_factory_lane、list_factory_lane_tasks、get_factory_lane_gate_context、list_promotions、get_promotion
代码历史记录explain_code
Anti-slopanti_slop_rules、anti_slop_scan

有关版本发布工具的信息,请参阅通过MCP实现的版本发布。

来自编辑器的Anti-slop规则

这两款Anti-slop工具可让开发者的本地代理在其生成的成果上应用Quality Control针对每个pull request设定的标准,即便该pull request尚未存在。

  • anti_slop_rules会返回项目已发布的Anti-slop策略:包括规则明细、哪些规则会触发拦截、自定义规则、被隔离的规则、Coroid可在公共仓库中查找的新依赖项,以及用于 AGENTS.md的代码片段,该片段为本地代理定义了相同的规则。可将此代码片段粘贴到AGENTS.md,或粘贴到.cursor/rules的Cursor版规则中。
  • anti_slop_scan会检查Coroid同步后的分支、标签或提交内容是否与基准(即默认分支,除非您指定了其他分支)一致。它仅执行读取操作:不会修改任何文件、运行任何命令、安装任何内容,也不会调用模型。其调用频率限制为每分钟5次。

扫描仅为预览功能。最终仍由Quality Control对pull request进行审核,其判定结果才是具有效力的结论。请参阅Anti-slop检查。

创建工作与变更

这些工具需要“成员”角色及对应的权限范围:mcp.work.write。

区域工具审批
任务create_task、update_task无
计划create_plan、update_plan无
计划delete_plan始终
迭代create_sprint、plan_sprint、add_task_to_sprint无
迭代remove_task_from_sprint始终
依赖项create_dependency无
报告create_report、update_report、create_report_folder、update_report_folder、create_report_subscription、update_report_subscription无
报告batch_update_reports、delete_report、delete_report_folder、delete_report_subscription始终

通过MCP创建的工作不会经过Qualification流程。发送至任务工具的计划类请求会生成草稿计划而非任务;通过MCP创建的计划初始状态为草稿。

运行工作

这些工具需要“成员”角色及对应的权限范围:mcp.execute。

区域工具审批
任务start_task_execution、retry_task_execution策略
任务stop_task_execution始终
计划start_planning_workflow、execute_plan、retry_plan_task_integration策略
计划cancel_plan始终
迭代start_sprint策略
报告pause_report、resume_report、cancel_report、retry_report_generation策略
Factorystart_global_execution、pause_global_execution、resume_global_execution、pause_factory_lane、resume_factory_lane策略
Factorycancel_global_execution、set_agent_execution_state始终

交付

这些工具需要“成员”角色及对应的权限范围:mcp.delivery。版本发布的相关说明详见下方独立章节。

工具审批
approve_plan、close_sprint、create_promotion、approve_promotion、request_promotion_changes、validate_factory_lane策略
force_merge_promotion始终

管理

这些工具用于调整组织及其项目的配置。

工具权限范围最低权限等级审批
create_project、update_project、restore_projectmcp.projects.admin管理员无
archive_projectmcp.projects.admin管理员始终
list_schedules、get_schedule、create_schedule、update_schedulemcp.schedules.admin管理员无
trigger_schedulemcp.schedules.admin管理员策略
delete_schedulemcp.schedules.admin管理员始终
list_integrations、get_integrationmcp.integrations.admin管理员无
test_integrationmcp.integrations.admin管理员策略
set_integration_status、delete_integrationmcp.integrations.admin管理员始终
create_integrationmcp.secrets.write所有者始终
list_organization_members、list_organization_invitationsmcp.organization.admin所有者无
invite_organization_member、update_organization_member_role、remove_organization_member、revoke_organization_invitation、update_organizationmcp.organization.admin所有者始终

组织设置

像Hermes这样的智能体可以根据截图、文件或描述来配置组织。它会读取Coroid的设置格式,将获取的内容写入一个包中,预览该包后再应用它。这些工具需要拥有所有者角色,且具备以下权限:mcp.organization.admin。

工具功能说明审批
describe_organization_settings_schema返回设置格式、其各章节及映射提示无
export_organization_settings导出当前设置,其中敏感信息会被替换为占位符无
preview_organization_settings_import展示包会带来的变更效果,但不会实际执行写入操作无
apply_organization_settings_import应用包,默认会将包内容合并到当前设置中,也可替换现有设置始终

包中会使用占位符代替敏感值,而Coroid会拒绝包含敏感信息的包。详情请参阅设置导出与导入。

通过MCP进行版本发布

版本发布工具与聊天助手使用的工具相同,且会经过与门户端一致的Release API流程:

工具权限范围审批
list_releases、get_release、list_release_commits、preview_release、get_release_settings、list_release_pull_requestsmcp.read无
create_release、update_release、run_release_checks、draft_release_notesmcp.delivery无
approve_release、request_release_deployment、bundle_release_pull_requestsmcp.delivery始终
update_release_versioningmcp.projects.admin无

create_release可接受完整的提交SHA值、近期提交的短SHA值,或者latest,除非你指定版本号,否则会采用项目自身的版本源。get_release会按环境分别报告检查结果、最后一次部署情况、流水线上报的版本,以及Coroid是否验证了运行中的版本。仅限部分项目使用的令牌无法访问其他项目的版本发布信息。Release API仍会执行其自身的审批规则,因此通过MCP完成的审批与在门户端完成的审批具有同等效力。

list_release_pull_requests会按Coroid建议的顺序返回项目的待处理pull request,同时说明被排除的request的原因。bundle_release_pull_requests会根据这些request创建版本发布:先创建一个合并了这些request的版本发布分支,再生成一条发布 pull request。它会推送分支并打开一个pull request,因此始终需要人工介入。可省略prNumbers以使用Coroid的选择结果。

审批与自动化策略

审批是一个等待人工处理的操作队列。自动化策略决定该队列中包含哪些操作。

这才是关键的控制点。代表你行事的外部客户端应能够自由执行常规操作,而涉及重大影响的操作则需经人工确认。在将令牌交给无人值守运行的程序前,请先设定好相关策略。

当调用需要审批时,客户端会收到审批ID和链接,而非直接返回结果。所有者或管理员会审核具体的工具和参数,随后批准或拒绝该调用。一旦批准,调用会严格按照原请求执行,客户端后续无法更改。若10分钟内无人审批,该调用会自动失效。

自动化策略允许标记为Policy的工具在无需等待审批的情况下运行。只有所有者才能创建策略并将其附加到令牌上。策略会明确指定允许使用的工具,可限定适用的项目范围,还能限制每小时、每天及同时运行的调用次数,也可设置过期时间。撤销策略会同时吊销所有关联令牌。标记为Always的工具不受策略约束。

OAuth连接无法携带策略。通过OAuth调用时,所有标记为Policy的工具都会等待审批。

重试、操作与资源

所有涉及变更的工具都需要该参数:idempotencyKey。每次新操作需使用新密钥,重试时则使用同一密钥。Coroid会返回首次操作的结果,而不会重复执行。若用不同参数重复使用同一密钥,请求会被拒绝。

变更操作还会返回一个用于记录其状态和结果的操作对象。以下四个工具适用于所有连接:

工具功能说明
get_operation返回操作的状态和结果
wait_for_operation最多等待25秒以查看操作状态变化
cancel_operation取消尚未开始的操作
get_approval返回审批的状态和结果

服务器还提供以下资源:

资源内容
coroid://context该连接的身份、角色、权限范围及所属项目
coroid://capabilities该连接可使用的工具
coroid://operations/{operationId}一个操作
coroid://approvals/{approvalId}一项审批

它还提供三条提示:create_and_run_task、investigate_failure、prepare_release。

每个工具都设有每分钟、每小时及每天的调用限制。超出限制的调用会失败,并提示下次可重试的时间。

刻意不公开的功能

工具注册表受到管控,相关排除项是故意设置的。它不会提供以下功能:

  • shell
  • Git访问权限
  • 文件系统
  • 原始数据库访问权限
  • 任意内部HTTP接口
  • Coroid自身的出站MCP管理工具

您将获得管理工作的能力:工作——创建并查看任务、计划、项目和发布版本——它并非远程执行环境。MCP客户端无法将Coroid用作运行任意命令的工具。

它的适用场景

在您已有的工作场景中驱动Coroid——无论是编辑器、助手还是内部工具——无需切换至门户。从终端创建任务,或让助手查询受阻事项,都将成为本地可直接操作的功能。