shortcut

Shortcut

Shortcut（原名 Clubhouse）是一个面向软件开发团队的项目管理平台。它提供路线图、迭代以及与 GitHub、Slack 等工具的集成，帮助团队更快地规划、构建和发布产品。软件工程师、产品经理和设计师会使用它来协作并跟踪软件项目的进展。

官方文档：https://shortcut.com/api/reference/api-overview

Shortcut 概览

• 快捷方式
  • 详细信息 — 名称、图标、键盘快捷键、服务
  • 操作 — 快捷方式中的步骤
• 文件夹

何时使用哪些操作：根据需要使用操作名称和参数。

使用 Shortcut

此技能使用 Membrane CLI 与 Shortcut 交互。Membrane 会自动处理身份验证和凭据刷新，因此你可以专注于集成逻辑，而不必处理身份验证相关的繁琐工作。

安装 CLI

安装 Membrane CLI，以便在终端中运行 membrane：

npm install -g @membranehq/cli@latest

身份验证

membrane login --tenant --clientName=<agentType>

根据是否提供交互模式，此命令会打开浏览器进行身份验证，或在控制台中打印授权 URL。

**无头环境：**该命令会打印授权 URL。请让用户在浏览器中打开该链接。用户完成登录后会看到一个代码，请使用以下命令完成验证：

membrane login complete <code>

在任何命令后添加 --json，即可获得机器可读的 JSON 输出。

Agent 类型：claude、openclaw、codex、warp、windsurf 等。系统会据此调整工具，以便更好地适配你的运行环境

连接到 Shortcut

使用 membrane connection ensure，通过应用 URL 或域名查找或创建连接：

membrane connection ensure "https://www.shortcut.com/" --json

用户在浏览器中完成身份验证。输出中包含新的连接 ID。

这是获取连接最快的方法。系统会将 URL 规范化为域名，并与已知应用进行匹配。如果找不到应用，系统会创建一个应用，并自动构建连接器。

如果返回的连接包含 state: "READY"，请跳到 步骤 2。

1b. 等待连接就绪

如果连接处于 BUILDING 状态，请轮询，直到连接就绪：

npx @membranehq/cli connection get <id> --wait --json

--wait 标志会进行长轮询（最长等待 --timeout 秒，默认值为 30），直到状态发生变化。持续轮询，直到 state 不再是 BUILDING。

当前状态会指示下一步操作：

• READY — 连接已完全设置。跳到 步骤 2。

• CLIENT_ACTION_REQUIRED — 用户或 Agent 需要执行某项操作。clientAction 对象会说明所需操作：

  • clientAction.type — 所需操作的类型：
    • "connect" — 用户需要进行身份验证（OAuth、API 密钥等）。这适用于初次身份验证，以及已断开连接时重新进行身份验证。
    • "provide-input" — 需要提供更多信息（例如，要连接的应用）。
  • clientAction.description — 对所需操作的易读说明。
  • clientAction.uiUrl（可选）— 用户可在其中完成操作的预构建 UI URL。若存在，请向用户显示。
  • clientAction.agentInstructions（可选）— 指示 AI Agent 如何以编程方式继续操作。

  用户完成操作（例如在浏览器中完成身份验证）后，再次运行 membrane connection get <id> --json 进行轮询，检查状态是否已变为 READY。

• CONFIGURATION_ERROR 或 SETUP_FAILED — 出现问题。请查看 error 字段了解详情。

搜索操作

使用自然语言描述你想要执行的操作进行搜索：

membrane action list --connectionId=CONNECTION_ID --intent "QUERY" --limit 10 --json

始终应在特定连接的上下文中搜索操作。

每个结果都包含 id、name、description、inputSchema（操作接受的参数）和 outputSchema（操作返回的内容）。

常用操作

名称	键	描述
列出故事	search-stories	使用查询字符串搜索 Shortcut 中的故事
列出项目	list-projects	列出 Shortcut 中的所有项目
列出史诗	list-epics	列出 Shortcut 中的所有史诗
列出迭代	list-iterations	列出工作区中的所有迭代
列出标签	list-labels	列出工作区中的所有标签
列出成员	list-members	列出工作区中的所有成员
列出群组	list-groups	列出工作区中的所有群组（团队）
获取故事	get-story	根据 ID 获取故事
获取项目	get-project	根据 ID 获取项目
获取史诗	get-epic	根据 ID 获取史诗
获取迭代	get-iteration	根据 ID 获取迭代
获取标签	get-label	根据 ID 获取标签
获取成员	get-member	根据 ID 获取成员
获取群组	get-group	根据 ID 获取群组（团队）
创建故事	create-story	在 Shortcut 中创建新故事
创建项目	create-project	在 Shortcut 中创建新项目
创建史诗	create-epic	在 Shortcut 中创建新史诗
创建迭代	create-iteration	创建新迭代（冲刺）
创建标签	create-label	创建新标签
更新故事	update-story	更新 Shortcut 中的现有故事

运行操作

membrane action run <actionId> --connectionId=CONNECTION_ID --json

传递 JSON 参数：

membrane action run <actionId> --connectionId=CONNECTION_ID --input '{"key": "value"}' --json

结果位于响应的 output 字段中。

代理请求

当可用操作无法满足你的使用场景时，可以通过 Membrane 的代理直接向 Shortcut API 发送请求。Membrane 会自动将基础 URL 附加到你提供的路径中，并注入正确的身份验证标头；如果凭据过期，还会自动刷新。

membrane request CONNECTION_ID /path/to/endpoint

常用选项：

标志	描述
-X, --method	HTTP 方法（GET、POST、PUT、PATCH、DELETE）。默认为 GET
-H, --header	添加请求标头（可重复），例如 -H "Accept: application/json"
-d, --data	请求正文（字符串）
--json	以简写方式发送 JSON 正文，并设置 Content-Type: application/json
--rawData	原样发送正文，不进行任何处理
--query	查询字符串参数（可重复），例如 --query "limit=10"
--pathParam	路径参数（可重复），例如 --pathParam "id=123"

最佳实践

• 始终优先使用 Membrane 与外部应用通信 — Membrane 提供预构建操作，并内置身份验证、分页和错误处理。这样可以减少令牌消耗，让通信更加安全
• 先发现，再构建 — 运行 membrane action list --intent=QUERY（将 QUERY 替换为你的意图），在编写自定义 API 调用前查找现有操作。预构建操作可以处理原始 API 调用容易遗漏的分页、字段映射和边缘情况。
• 让 Membrane 管理凭据 — 切勿向用户索要 API 密钥或令牌。请改为创建连接；Membrane 会在服务端管理完整的身份验证生命周期，无需在本地保存密钥。