help-scout

Help Scout

Help Scout 是一个客户支持平台，提供共享收件箱、知识库管理和在线聊天功能。SaaS 和电商领域的客服团队使用它来高效管理和回复客户咨询。

官方文档：https://developers.helpscout.com/api/

Help Scout 概览

• 对话
  • 客户
  • 用户
  • 附件
• 客户
• 用户
• 批量操作
• 文章
• 搜索

使用 Help Scout

此技能使用 Membrane CLI 与 Help Scout 交互。Membrane 会自动处理身份验证和凭据刷新，因此你可以专注于集成逻辑，而不必操心身份验证的细节。

安装 CLI

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

npm install -g @membranehq/cli@latest

身份验证

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

如果交互模式可用，此命令会打开浏览器进行身份验证；否则会在控制台中打印授权 URL。

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

membrane login complete <code>

在任意命令中添加 --json，即可获取机器可读的 JSON 输出。

Agent 类型：claude、openclaw、codex、warp、windsurf 等。这些类型将用于调整工具配置，使其最适合你的运行环境。

连接到 Help Scout

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

membrane connection ensure "https://www.helpscout.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（可选）— 预先构建的界面 URL，用户可在此完成所需操作。如果存在，请向用户展示此 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（操作返回的内容）。

常用操作

使用 npx @membranehq/cli@latest action list --intent=QUERY --connectionId=CONNECTION_ID --json 发现可用操作。

运行操作

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

传入 JSON 参数：

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

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

代理请求

当可用操作无法满足你的使用场景时，可以通过 Membrane 的代理直接向 Help Scout 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 会在服务器端管理完整的身份验证生命周期，不需要本地机密。