mcpField
C
CheckFlow

CheckFlow

远程服务
docs.checkflow.io生产力04 天前更新

关于 CheckFlow

CheckFlow MCP Server 将 AI 助手连接到 CheckFlow 工作区,用于管理清单、任务、模板、数据集和日程。该服务由 CheckFlow 托管,提供 147 个工具,并支持账户登录或 API 密钥认证。

主要功能

  1. 01创建和管理清单及任务
  2. 02搜索任务并查看活动记录
  3. 03创建并发布流程模板
  4. 04批量管理数据集记录
  5. 05创建定期日程

适用场景

  1. 01查找本周到期的任务
  2. 02填写清单任务并添加备注
  3. 03将操作流程转为模板

MCP 相关

托管服务通过 Streamable HTTP 提供 CheckFlow 工作区操作,并为美国和欧洲提供不同端点。MCP 客户端可使用 OAuth 2.1 登录或 API 密钥认证。

配置

远程服务无需本地安装。选择你使用的客户端,复制配置或使用一键安装。

服务地址https://api.checkflow.io/mcp
一键复制安装命令
Claude CodeTerminal
Cursor.cursor/mcp.json
VS Code.vscode/mcp.json
Claude Desktopclaude_desktop_config.json
Windsurf~/.codeium/windsurf/mcp_config.json

命令在终端中运行;JSON 粘贴到对应客户端的 MCP 配置后重启。需要授权的服务会在首次连接时提示登录。

全部服务地址
Streamable HTTPhttps://api.checkflow.io/mcp需要授权
Streamable HTTPhttps://api-eu.checkflow.io/mcp需要授权

工具

详细介绍

CheckFlow MCP 服务

CheckFlow 的官方 MCP 服务,适用于清单和流程软件 CheckFlow。将 AI 助手连接到你的 CheckFlow 工作区,然后用日常语言提出请求:启动清单、告诉我哪些事项已逾期、填写此任务,或将此流程转为模板。

该服务由 CheckFlow 托管。无需安装或运行任何程序:将下方地址添加到 MCP 客户端,然后使用 CheckFlow 账户登录,或发送 API 密钥即可。此代码库包含文档,以及发布到 MCP Registry 的 server.json;服务端代码并非开源。

服务地址(美国)https://api.checkflow.io/mcp
服务地址(欧洲)https://api-eu.checkflow.io/mcp
传输方式Streamable HTTP,无状态(JSON 响应,无会话,无事件流)
身份验证使用 CheckFlow 账户登录(OAuth 2.1,MCP 授权规范),或在 X-API-KEY 标头中提供 API 密钥
工具147 个,分为八类
资源1 个,即模板编写指南
套餐适用于所有 CheckFlow 套餐,也支持 14 天免费试用
完整文档docs.checkflow.io/docs/mcp/overview

你可以这样提出请求

你提出请求助手会
“我这周有哪些待办事项?”读取你的任务网格,并筛选出本周到期的任务。
“使用 Invoice Review 模板创建清单,编号为 INV-2041,截止日期为星期五,并将审批任务分配给 Sarah。”使用 Invoice Review 模板创建清单,设置截止日期并分配任务。
“将银行详情核查标记为已完成,并备注 IBAN 已通过电话核实。”填写任务字段、添加评论并完成任务。
“哪些供应商入驻流程已停滞超过两周?”搜索清单并读取其活动记录。
“将此流程文档转为模板。”读取编写指南、编写模板、验证模板、修复验证器报告的问题并发布模板。
“将这 12 家供应商添加到 Suppliers Data Set。”通过一次批量调用创建记录。
“设置每周一上午 9 点执行的清单,用于每周库存检查。”创建计划。

助手使用其自身提供方的 AI,而非 CheckFlow 的 AI,因此不会使用你工作区的 AI 额度。

两种连接方式

  • 使用 CheckFlow 账户登录。 客户端会在浏览器中打开 CheckFlow;你登录并选择允许后,助手便会以你的身份操作。无需复制或保存密钥。这是连接 claude.ai、Claude Desktop 的 Connectors 页面、Claude 移动应用和 ChatGPT 的唯一方式。
  • 使用 API 密钥,并在 X-API-KEY 标头中发送。适用于无法登录的客户端、需要以其他用户或工作区身份操作的助手,以及脚本。

开始之前

  1. 使用你所在区域的地址。 美国的工作区使用 https://api.checkflow.io/mcp;欧洲的工作区使用 https://api-eu.checkflow.io/mcp。向另一个区域发送请求会收到 WRONG_REGION 错误,错误消息中会注明正确地址。
  2. 确认你有权连接。 管理员可以在 Team Management 的 AI 选项卡中关闭 允许 AI 助手连接;除非有人将其关闭,否则该选项默认开启。成员需要 AI.Assistant 权限,新成员默认拥有此权限,管理员也可以在 Users 选项卡中授予或撤销该权限。管理员无需此权限。访客无法连接助手。
  3. 仅适用于 API 密钥: 管理员可在 Team Management 的 API & Integrations 选项卡中创建密钥。若要用于个人助手,请创建一个以你的身份操作的密钥。请参阅创建 API 密钥。登录无需密钥。

示例使用美国地址;如果你的工作区位于欧洲,请使用欧洲地址。

登录

  1. 浏览器会打开一个 CheckFlow 页面,其中会显示请求连接的助手名称。
  2. 按照平时的方式登录:使用邮箱和密码、Google 或 Microsoft 账号,或者使用公司的单点登录。使用单点登录时,请输入工作区地址(例如,acme.checkflow.io 中的 acme),CheckFlow 会将你带到公司的登录页面。
  3. CheckFlow 会显示助手可以执行的操作、对应的工作区,以及它会将你带回的地址。检查这些信息,然后点击 Allow。
  4. 浏览器会返回助手,此时连接已建立。

助手会以你的身份,在你登录的工作区中运行。如果你属于多个工作区,请在连接前先在 CheckFlow 中切换到正确的工作区;如果还要连接另一个工作区,请再次添加该服务,并在选中该工作区时连接。连接会一直有效,直到你或管理员断开连接,或者连续 30 天未使用。如果你离开工作区或被设为访客,连接也会失效。

连接客户端

Claude(网页、桌面和移动端)
  1. 在 Claude 中打开设置,然后选择连接器,并点击 Add custom connector。
  2. 将其命名为 CheckFlow,输入服务地址,然后添加。
  3. 点击 Connect 并登录。

你在网页端添加的连接器也可在 Claude 桌面和移动应用中使用。使用 Team 或 Enterprise 计划时,组织所有者可能需要先为组织添加连接器,成员才能连接。

ChatGPT

ChatGPT 在开发者模式下连接自定义 MCP 服务。按照 OpenAI 关于连接远程 MCP 服务的说明,提供服务地址,并选择 OAuth 作为身份验证方式。ChatGPT 会自动找到 CheckFlow 的登录页面,因此无需进行其他配置。然后登录。

Claude Code
claude mcp add --transport http checkflow https://api.checkflow.io/mcp

然后,在 Claude Code 中运行 /mcp,选择 checkflow 并点击 Authenticate。浏览器会打开,以便你登录。

若要改用 API 密钥连接,请添加以下请求头:

claude mcp add --transport http checkflow https://api.checkflow.io/mcp --header "X-API-KEY: your-api-key-here"

在任一命令中添加 --scope user,即可让所有项目都能使用该服务,而非仅限当前项目。运行 claude mcp list,检查是否已连接,然后向 Claude 提出类似“列出我的 CheckFlow 模板”的请求。

Cursor

将服务添加到 ~/.cursor/mcp.json,即可供所有项目使用;也可以添加到某个项目中的 .cursor/mcp.json。如果只提供地址,启用服务时 Cursor 会提示你登录:

{
  "mcpServers": {
    "checkflow": {
      "url": "https://api.checkflow.io/mcp"
    }
  }
}

若要改用 API 密钥,请添加一个 headers 条目:

{
  "mcpServers": {
    "checkflow": {
      "url": "https://api.checkflow.io/mcp",
      "headers": {
        "X-API-KEY": "your-api-key-here"
      }
    }
  }
}

打开 Cursor 的 MCP 设置,检查服务是否显示为已连接,以及是否列出了相关工具。

Visual Studio Code

将服务添加到工作区中的 .vscode/mcp.json。如果只提供地址,服务启动时 VS Code 会提示你登录:

{
  "servers": {
    "checkflow": {
      "type": "http",
      "url": "https://api.checkflow.io/mcp"
    }
  }
}

若要改用 API 密钥,请添加一个 inputs 块。VS Code 会提示你输入一次密钥并安全存储,而不会将其保存在文件中:

{
  "inputs": [
    {
      "type": "promptString",
      "id": "checkflow-api-key",
      "description": "CheckFlow API key",
      "password": true
    }
  ],
  "servers": {
    "checkflow": {
      "type": "http",
      "url": "https://api.checkflow.io/mcp",
      "headers": {
        "X-API-KEY": "${input:checkflow-api-key}"
      }
    }
  }
}

从文件或 MCP: List Servers 命令启动服务,然后在 Agent 模式下通过 Copilot Chat 使用这些工具。

使用 API 密钥的 Claude Desktop

如上所述,Claude Desktop 的连接器界面会引导你登录。若要改用 API 密钥连接 Claude Desktop,请使用 mcp-remote 桥接工具,该工具需要 Node.js 18 或更高版本。打开设置,然后选择开发者,再点击 Edit Config。在 mcpServers 下添加一个 checkflow 条目:

{
  "mcpServers": {
    "checkflow": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://api.checkflow.io/mcp",
        "--header",
        "X-API-KEY:${CHECKFLOW_API_KEY}"
      ],
      "env": {
        "CHECKFLOW_API_KEY": "your-api-key-here"
      }
    }
  }
}

保存文件并重启 Claude Desktop。请将请求头写为 X-API-KEY:${CHECKFLOW_API_KEY},冒号后不要加空格:某些平台会按空格拆分参数,从而导致请求头无法正常工作。

配置文件经常会同步、备份或共享。如果客户端支持环境变量或密钥提示,请使用这些方式,而不是将 API 密钥粘贴到文件中。登录则完全无需存储密钥。

MCP Inspector

MCP Inspector 可以让你探索工具并手动调用它们。这是检查密钥最快的方法。

  1. 运行 npx @modelcontextprotocol/inspector。
  2. 选择 Streamable HTTP 传输方式,并输入 https://api.checkflow.io/mcp。
  3. 添加名为 X-API-KEY 的自定义标头,并填入你的密钥。
  4. 点击 Connect,然后点击 List Tools。
其他客户端

任何能够通过 Streamable HTTP 连接到远程 MCP 服务,并且符合以下任一条件的客户端都可以使用:

  • 使用 MCP 授权规范(OAuth 2.1)登录,或
  • 在每个请求中通过 X-API-KEY 标头或 Authorization: Bearer your-api-key-here 发送 API 密钥。

Authorization: Bearer 形式适用于可以发送 bearer token、但不能发送自定义标头的客户端,例如 Claude API 中的 MCP 连接器和 Microsoft 365 Agent 连接器。如果请求同时携带这两个标头,则使用 X-API-KEY。

CheckFlow 只会向其支持的助手地址发送登录请求:Claude、Claude Code、ChatGPT、VS Code、Cursor、Microsoft 365 Copilot,以及其他在你自己的计算机上接收登录请求的桌面应用。如果客户端的登录页面提示 CheckFlow 不会向其地址发送登录请求,请使用 API 密钥连接,或联系 支持团队 添加该客户端。

checkflow.io 上提供了更多分步指南:Claude 和 Copilot。

断开助手连接

  • 通过登录连接的助手: 从姓名下方的菜单打开 My Profile & Settings,前往 AI Assistants 选项卡,然后点击该助手旁边的 Disconnect。在助手中移除连接器也会结束连接。
  • 任何成员的助手(管理员操作): 在 Team Management 的 API & Integrations 选项卡中,从 Connected AI assistants 下找到该助手并撤销连接。
  • 使用 API 密钥的助手: 管理员在 API & Integrations 选项卡中撤销密钥。
  • 一次性断开所有助手: 管理员在 AI 选项卡中关闭 Allow AI assistants to connect。这不会影响 REST API。

检查连接

向你的助手询问:“你连接的是哪个 CheckFlow 工作区?”它会根据 get_workspace_info 作答,该工具会返回工作区的名称、区域、成员、群组、标签和模板。

你看到的内容原因解决方法
登录页面显示 This application cannot connect。CheckFlow 无法识别客户端,或无法识别它要求将你返回到的地址。从客户端移除该服务,然后重新添加。如果问题仍然出现,请使用 API 密钥连接。
登录页面显示管理员已关闭来自 AI 助手的连接。Allow AI assistants to connect 已关闭。请管理员在 AI 选项卡中重新开启。
登录页面显示访客无法连接 AI 助手。你是此工作区中的访客。请管理员将你的身份改为成员。
登录页面显示你没有 AI.Assistant 权限。管理员尚未授予你 AI.Assistant 权限。请管理员在 Users 选项卡中授予该权限。
助手连接到了错误的工作区。连接时,你登录的是另一个工作区。断开连接,在 CheckFlow 中切换工作区,然后重新连接。
助手要求你重新连接或登录。连接已断开或撤销、连续 30 天未使用,或者你已离开工作区或被设为访客。重新连接。
使用 API 密钥时出现授权错误或 401 错误密钥缺失、输入错误、已撤销或已过期,或者无法再以该密钥所属成员的身份执行操作。检查标头名称是否准确为 X-API-KEY,然后从 API & Integrations 选项卡重新复制密钥。
WRONG_REGION工作区位于另一个区域。使用错误消息中提供的地址。如果你已登录,请移除该连接,然后使用该地址重新连接。
API_KEY_ACTS_AS_WORKSPACE该密钥以工作区身份执行操作,而该工具针对的是个人。使用以成员身份执行操作的密钥,或登录。
RATE_LIMIT_EXCEEDED工作区已用完每小时额度。等待错误消息中指定的秒数。
AI_ASSISTANT_NOT_PERMITTED助手所代表的成员没有 AI.Assistant 权限。请管理员在 Users 选项卡中授予该权限。无需重新连接,权限会在一分钟内生效。
MCP_DISABLED管理员已关闭 Allow AI assistants to connect。请管理员在 AI 选项卡中重新开启。

工具

共有 147 个工具,分为八个类别。每个工具都有标题、面向模型编写的描述、用于其参数的 JSON Schema,以及用于告知客户端该工具是只读(57 个工具)、可在应用中撤销操作的写入工具(64 个),还是破坏性工具(26 个)的注解。大多数客户端会在运行破坏性工具前征求确认。完整参考文档:docs.checkflow.io/docs/mcp。

检查清单(15 个):列出、搜索、创建、完成、归档、共享和添加标签

list_checklists、search_checklists、get_checklist、get_checklist_activity、list_attached_tasks、create_checklist、update_checklist、delete_checklist、set_checklist_archived、set_checklist_complete、add_checklist_tags、remove_checklist_tag、get_checklist_share、set_checklist_share、stop_sharing_checklist

参考文档

检查清单任务(27 个):完成任务、填写字段和表格、管理文件、受派人、截止日期、评论、稍后提醒和标签 `list_checklist_tasks`、`get_task`、`get_task_activity`、`complete_task`、`uncomplete_task`、`set_task_not_applicable`、`clear_task_not_applicable`、`set_task_assignees`、`clear_task_assignees`、`set_task_due_date`、`clear_task_due_date`、`add_task_tags`、`remove_task_tag`、`get_task_fields`、`set_task_fields`、`get_task_files`、`add_task_file`、`remove_task_file`、`get_task_table_rows`、`add_task_table_row`、`remove_task_table_row`、`set_task_table_cell`、`add_task_comment`、`remove_task_comment`、`get_task_snooze`、`set_task_snooze`、`end_task_snooze`

参考

独立任务(26):在清单之外创建和管理任务,支持子任务、评论和文件

raise_task、get_standalone_task、update_standalone_task、delete_standalone_task、complete_standalone_task、uncomplete_standalone_task、set_standalone_task_not_applicable、clear_standalone_task_not_applicable、get_standalone_task_activity、add_standalone_task_tags、remove_standalone_task_tag、get_standalone_task_comments、add_standalone_task_comment、remove_standalone_task_comment、get_standalone_task_files、add_standalone_task_file、remove_standalone_task_file、get_standalone_task_sub_tasks、add_standalone_task_sub_tasks、update_standalone_task_sub_task、remove_standalone_task_sub_task、complete_standalone_task_sub_task、uncomplete_standalone_task_sub_task、get_standalone_task_snooze、set_standalone_task_snooze、end_standalone_task_snooze

参考

工作区、人员和任务网格(12):成员、群组、标签、任务网格及其已保存的视图

list_tags、list_members、get_member、list_groups、get_group、list_my_work、snooze_tasks、end_snooze_tasks、list_my_work_views、create_my_work_view、update_my_work_view、delete_my_work_view

参考

模板编写(30):工作区摘要、架构和编写指南、模板、版本、权限、升级和草稿

get_authoring_guide、get_template_schema、list_content_types、describe_content_type、list_condition_operators、list_due_date_scenarios、get_workspace_info、list_templates、get_template、list_template_versions、export_template、set_template_archived、list_template_permissions、set_template_permissions、validate_template、copy_template、create_template、create_template_version、list_checklist_upgrades、upgrade_checklists、create_template_draft、list_template_drafts、get_template_draft、replace_template_draft、update_template_draft、apply_draft_operations、validate_template_draft、commit_template、get_commit_status、delete_template_draft

参考

数据集(21):数据集、字段、记录、视图,以及 CSV 导入和导出

list_data_sets、get_data_set、create_data_set、update_data_set、delete_data_set、list_data_set_connections、create_data_set_field、update_data_set_field、delete_data_set_field、list_data_set_records、get_data_set_record、create_data_set_record、update_data_set_record、create_data_set_records、delete_data_set_records、create_data_set_view、update_data_set_view、delete_data_set_view、create_data_set_from_csv、replace_data_set_records_from_csv、export_data_set_csv

参考

计划(9):定期计划及其运行记录 `list_schedules`, `get_schedule`, `create_schedule`, `update_schedule`, `delete_schedule`, `list_schedule_runs`, `get_schedule_run`, `delete_schedule_run`, `create_schedule_run_checklist`

参考

Webhooks(7):webhook 订阅、投递和重放

list_webhooks, get_webhook, list_webhook_deliveries, replay_webhook_delivery, create_webhook, update_webhook, delete_webhook

参考

服务还提供一个资源 checkflow://guides/template-authoring:一份编写 CheckFlow 模板的指南。支持资源的客户端可以将其附加到对话中。它没有提示词。

助手以谁的身份操作

  • **已登录:**助手以你的身份,在你连接时登录的工作区中操作。通过登录建立的连接始终以登录者的身份操作,不会以其他人或工作区的身份操作。
  • **使用 API 密钥:**每个密钥都以工作区的一名成员或工作区本身的身份操作,具体取决于创建密钥时的选择。以工作区身份操作的密钥无法使用与个人相关的工具,例如任务网格和延后处理功能。

无论哪种方式,助手都只能看到该成员能看到的内容,所做的更改都会记在该成员名下,并且在该成员会被拒绝访问的地方,助手也会被拒绝访问。

安全使用

已连接的助手可以对你的工作区进行实际更改,而模型可能会误解请求。

  • 如果客户端支持,请通过登录进行连接。这样就无需存储或泄露密钥,并且连接能执行的操作不会超出你的权限。
  • 如果使用密钥,请选择权限最低但足以完成任务的成员所对应的密钥;除非助手确实需要,否则不要提供管理员密钥。为每个助手单独创建一个以其名称命名的密钥,这样你就能查看其上次使用时间,并单独撤销该密钥。请将密钥视为机密信息。
  • 保持客户端的确认提示处于启用状态。通过 MCP 服务删除检查清单、独立任务、数据集或其记录,与在应用中删除一样,都是永久操作。
  • 断开不再使用的连接(参见断开助手连接)。

限制

MCP 请求与 REST API 共用工作区的速率限制:每小时 1,000 次标准请求和 10,000 次低成本请求,由工作区的所有密钥和 MCP 连接共享。列出工具、读取架构和编写指南以及验证模板都会计入低成本请求额度。无论服务器一次批处理多少条消息,每次请求都只计为一次。请参阅速率限制。

面向开发者

该服务通过一个端点使用 JSON-RPC 2.0:每条消息都是发往 /mcp 的 POST 请求,每个响应都是 JSON。对于需要初始化的客户端,服务会响应 initialize,但无需初始化也可以使用 tools/list 和 tools/call。工具会以 structuredContent 和文本副本的形式,返回与对应的 REST API v3 请求相同的数据。如果请求被拒绝(例如模板不存在或值未通过验证),工具结果会包含 isError: true 和错误代码,以便模型自行修正。对于不适合重复执行的写入操作,可以选择提供 idempotencyKey。

登录遵循 MCP 授权规范:使用 OAuth 2.1 授权码流程和 PKCE(S256),仅支持公共客户端,并通过 Client ID Metadata Document 或 Dynamic Client Registration 进行标识。未提供凭据的请求会收到 401 响应,其中包含指向 /.well-known/oauth-protected-resource/mcp 处受保护资源元数据(RFC 9728)的 WWW-Authenticate 质询。访问令牌有效期为 1 小时,仅适用于 /mcp,并以登录者的身份操作;刷新令牌每次使用时都会轮换。详情请参阅:MCP 服务的工作方式。

POST https://api.checkflow.io/mcp
X-API-KEY: your-api-key-here
Content-Type: application/json

{ "jsonrpc": "2.0", "id": 1, "method": "tools/list" }

链接

支持

请发送邮件至 [email protected]。请将安全问题报告至 [email protected]。

其他目录中名为“CheckFlow”的连接器由第三方构建,并不由 CheckFlow 提供,也不在本文档的涵盖范围内。

评论

支持 Markdown

第一次接触 MCP?

从协议是什么,到在客户端里装上第一个服务,这几条回答覆盖了大多数入门问题。

一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。