文档

Coroid 作为 MCP 服务器

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

Coroid 提供远程 Model Context Protocol (MCP) 服务器。Hermes、Codex 或 Claude Code 等外部助手或智能体可通过该服务器,借助聊天助手所使用的同一套受管控的工具注册表,与 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。请将令牌存储在 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

其他客户端

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

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

访问令牌

令牌的创建和管理路径为访问令牌。与其他凭证一样,令牌仅会显示一次,之后便不会再返回给使用者。

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

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

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

权限范围和角色

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

权限范围可访问的内容最低角色要求
mcp.read读取项目、任务、计划、迭代、报告、依赖关系、产能及活动数据、智能体运行记录、Factory通道、升级流程和版本发布信息审核员
mcp.work.write创建和修改任务、计划、迭代、依赖关系和报告成员
mcp.execute启动、停止、重试、暂停、恢复和取消工作成员
mcp.delivery审批计划、关闭迭代、执行升级、通道验证和版本发布成员
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 通道与推广list_factory_lanes、get_factory_lane、list_factory_lane_tasks、get_factory_lane_gate_context、list_promotions、get_promotion
代码历史explain_code

关于发布工具,请参阅通过 MCP 进行版本发布。

创建与更改工作项

使用这些工具需要具备 Member 角色及以下权限范围: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 创建的工作项不会经过资格审核流程。发送至任务工具的计划规模请求会生成草稿计划而非任务;通过 MCP 创建的计划初始状态为草稿。

正在运行的工作

使用这些工具需要具备 Member 角色及以下权限范围: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始终

交付

使用这些工具需要具备 Member 角色及以下权限范围: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_requestsCoroid会按建议顺序返回项目中的未合并拉取请求,同时说明被排除的拉取请求的原因。bundle_release_pull_requests系统会据此创建版本发布:即生成对应的版本分支,其中会按序合并相关 pull 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,无需切换至门户。您既可以在终端创建任务,也能让助手协助查询受阻事项,所有操作均可在本地完成。