跳到主要内容
API & MCPMCP:专门给 Agent 使用

API & MCP

MCP:专门给 Agent 使用

用同一把 Public API Key,将自己的 Agent 连接到 Hast AIP。

本页专门面向 Agent 客户端及其配置者。Public API 与 MCP 提供同等的 AIP 业务能力,共用一把 Key、同一个 Profile 和相同权限。在 AIP → API 密钥创建或复用 Key,无需第二种 MCP Key。按需选择读写权限;CRM 和客户沟通知识库使用 business-resources:read/write,已有 Key 不会自动获得新增权限。

连接配置

从 API 密钥页链接的 API 文档取得当前环境的 Backplane 地址,替换下面的 BACKPLANE_URL。传输方式为 Streamable HTTP,每次请求使用 Authorization: Bearer hast_pk_...。客户端必须支持自定义请求头;下方是常见配置格式,请按实际客户端调整。真实密钥存放在安全凭据配置中,不写进 Prompt 或仓库。此入口使用 API Key,不使用 MCP OAuth 自动发现。

{
  "mcpServers": {
    "hast": {
      "url": "BACKPLANE_URL/api/public/v1/mcp",
      "headers": { "Authorization": "Bearer <YOUR_EXISTING_PUBLIC_API_KEY>" }
    }
  }
}

复制给你的 Agent 的 Prompt

请帮我连接 Hast AIP 的 MCP,让你能够根据我的需求创建和管理 Agent、渠道、知识库、CRM 和 Connector。

MCP 地址:BACKPLANE_URL/api/public/v1/mcp
连接方式:Streamable HTTP
认证方式:使用我现有的 Public API Key,通过 Authorization: Bearer 请求头发送。从 HAST_API_KEY 环境变量或安全凭据存储中读取,不要显示密钥。

连接后,阅读 hast://guides/overview 了解平台功能,随后根据我的需求,按需查阅相关指南并调用工具。

如果需要我补充信息、配置客户端或完成外部服务授权,请告诉我具体步骤。

发现平台功能

连接后读取以下资源,获得前置条件、请求示例、创建顺序、权限要求和验证步骤。不支持资源的客户端可调用 get_guides_topic,参数为 path.topic;REST 客户端通过 GET /api/public/v1/guides/{topic} 读取相同内容。

  • hast://guides/overview
  • hast://guides/enterprise-agent
  • hast://guides/channels
  • hast://guides/whatsapp
  • hast://guides/knowledge-crm
  • hast://guides/connectors

创建并验收企业级 Agent

  1. 发现实际模型、能力选项、已有 Agent、Skills、知识库和已连接账号。
  2. 创建需要的 Skill、只写 Secret、已完成索引的知识库,以及可选的 CRM 和沟通知识库。
  3. 通过 POST /webhooks 保存 AIP Agent,只选择当前 Profile 的资源及所需能力。
  4. 完成第三方授权和安装,绑定渠道并读取最终回复策略。
  5. 调用 /webhooks/{hook_id}/invoke,分页读取会话事件直到终态,再验证实际知识回答、CRM 读写、Connector 操作和原渠道回复。
  6. 按需配置定时任务,验证时区、下次执行时间和运行历史。未完成的授权或投递必须明确说明。

API 功能对等与边界

工具映射到同一份公开路由和权限检查。JSON 参数区分 pathquerybody;结果包含 statusbody,HTTP 失败会设置 MCP isError。文件上传使用 upload.filenameupload.data_base64 和可选 form,解码后最多 10 MiB。MCP 通过有限分页读取事件,REST 同时提供 SSE;MCP 回复最多 16 MiB,更大的归档使用 Public API 下载。202 只表示已接受,不能视为执行完成。第三方授权、真实消息投递及账号计费条件仍需满足。撤销同一把 Key 会同时停止 API 与 MCP 访问。

MCP transport specification · Tools · Resources · Official Go SDK