nutshell

Nutshell

Nutshell 是一个 CRM 和销售自动化平台，专为希望集中管理潜在客户、联系人和交易的 B2B 销售团队设计。销售代表和经理使用它来跟踪销售渠道并提升团队绩效。

官方文档：https://support.nutshell.com/hc/en-us/categories/200369036-Nutshell-API

Nutshell 概览

• 潜在客户
  • 联系人
  • 产品
  • 活动
• 商机
  • 联系人
  • 产品
  • 活动
• 客户
  • 联系人
  • 活动
• 联系人
  • 活动
• 用户
• 任务
• 会议
• 电话

根据需要使用操作名称和参数。

使用 Nutshell

此技能使用 Membrane CLI 与 Nutshell 交互。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 等。这些类型将用于调整工具，以便更好地适配你的运行环境。

连接到 Nutshell

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

membrane connection ensure "https://www.nutshell.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，用户可在其中完成操作。存在此字段时，请将其展示给用户。
  • 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（操作会返回什么）。

常用操作

名称	键	描述
查找潜在客户	find-leads	查找符合指定查询条件的潜在客户，支持分页
查找客户	find-accounts	查找符合指定查询条件的客户，支持分页
查找联系人	find-contacts	查找符合指定查询条件的联系人，支持分页
查找任务	find-tasks	查找符合指定查询条件的任务，支持分页
查找活动	find-activities	查找符合指定查询条件的活动，支持分页
获取潜在客户	get-lead	按 ID 获取指定的潜在客户
获取客户	get-account	按 ID 获取指定的客户
获取联系人	get-contact	按 ID 获取指定的联系人
获取任务	get-task	按 ID 获取指定的任务
获取活动	get-activity	按 ID 获取指定的活动
创建潜在客户	create-lead	在 Nutshell CRM 中创建新的潜在客户（销售机会）
创建客户	create-account	在 Nutshell CRM 中创建新的客户（公司／组织）
创建联系人	create-contact	在 Nutshell CRM 中创建新的联系人
创建任务	create-task	在 Nutshell CRM 中创建新的任务
创建活动	create-activity	在 Nutshell CRM 中创建新的活动（会议、通话等）
更新潜在客户	update-lead	更新 Nutshell CRM 中的现有潜在客户
更新客户	update-account	更新 Nutshell CRM 中的现有客户
更新联系人	update-contact	更新 Nutshell CRM 中的现有联系人
更新任务	update-task	更新 Nutshell CRM 中的现有任务
更新活动	update-activity	更新 Nutshell CRM 中的现有活动

运行操作

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

传递 JSON 参数：

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

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

代理请求

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