Hub API代理工具

一个基于MCP协议的服务器,将Hub API操作作为工具暴露给AI代理和MCP兼容客户端使用。

  • by Caiuriuller
  • TypeScript
  • 本地部署
  • 1 星标
  • 更新于
在 GitHub 查看 Caiuriuller/srp-hub-mcp

使用说明

srp集线器mcp

一 MCP(模型上下文协议) 服务器,将Hub API操作公开为AI代理和MCP兼容客户端的工具(例如Claude Desktop、GitHub Copilot、Cursor)。

概述

srp-hub-mcp 作为人工智能助手和Hub API之间的桥梁。它作为一个基于本地stdio的MCP服务器运行,允许AI代理使用结构化、经过验证的输入与Hub资源进行交互,例如创建客户线索。

需求

  • Node.js>=18
  • A有效 HUB_API_TOKEN 用于针对集线器API进行身份验证

安装

npm install
npm run build

配置

服务器是通过环境变量配置的:

变量 必填 默认 描述
HUB_API_TOKEN 是 - 集线器API身份验证的承载令牌
HUB_API_BASE 没有 http://localhost:3001/v2 集线器API的基本URL

用法

直接运行

HUB_API_TOKEN=your_token node build/index.js

MCP客户端配置

将以下内容添加到MCP客户端配置中(例如。 mcp.json 或 claude_desktop_config.json):

{
  "mcpServers": {
    "srp-hub-mcp": {
      "command": "npx",
      "args": ["srp-hub-mcp"],
      "env": {
        "HUB_API_TOKEN": "your_token_here",
        "HUB_API_BASE": "https://your-hub-api.example.com/v2"
      }
    }
  }
}

通过NPX在克劳德桌面(Windows)上运行

第一步——安装Node.js

下载并安装 Node.js>=18 从 https://nodejs.org.
选择 长期支持 Windows安装程序(.msi).

打开以验证安装 命令提示符 或 PowerShell:

node -v   # should print v18.x.x or higher
npm -v
npx -v

步骤2--安装Claude桌面

从下载并安装Claude Desktop https://claude.ai/download.
至少打开一次,以便创建其配置文件夹。

步骤3——打开Claude Desktop配置文件

配置文件位于:

%APPDATA%\Claude\claude_desktop_config.json

您可以按快速打开它 赢+R,粘贴下面的路径,然后按 进入:

%APPDATA%\Claude\claude_desktop_config.json

或手动导航:

C:\Users\<YourUsername>\AppData\Roaming\Claude\claude_desktop_config.json

如果文件尚不存在,请在该文件夹中将其创建为新的空文件。

步骤4——添加MCP服务器配置

打开 claude_desktop_config.json 使用任何文本编辑器(例如记事本、VS Code)并添加下面的块。
如果文件已为空,请粘贴整个代码段。如果它已经有内容,请合并 mcpServers 钥匙。

{
  "mcpServers": {
    "srp-hub-mcp": {
      "command": "npx",
      "args": ["-y", "srp-hub-mcp"],
      "env": {
        "HUB_API_TOKEN": "your_token_here",
        "HUB_API_BASE": "https://your-hub-api.example.com/v2"
      }
    }
  }
}

替换 your_token_here 与你的真实 HUB_API_TOKEN 并更新 HUB_API_BASE 指向您的Hub API实例。
这 -y 旗在 args 告诉NPX跳过安装确认提示。

步骤5--保存并重新启动Claude Desktop

  1. 保存 claude_desktop_config.json.
  2. 完全退出Claude Desktop(右键单击托盘图标→ 退出).
  3. 重新打开克劳德桌面。

步骤6——验证集成

在Claude Desktop中启动新对话,并询问:

“你们有什么MCP工具?”

克劳德应该列出 post_customer 在可用的工具中。然后,您可以要求它创建一个客户,它将通过该服务器使用Hub API。

故障排除

问题 解决方案
npx: command not found 重新安装Node.js并确保它已添加到 PATH
Cannot find package 'srp-hub-mcp' 包必须发布到npm(npm publish)或使用本地路径(见下文)
HUB_API_TOKEN errors 仔细检查中的令牌值 claude_desktop_config.json
工具未出现 确认JSON有效(没有尾随逗号)并重新启动Claude Desktop

可用工具

post_customer

在Hub中创建新客户(潜在客户)。

字段 类型 必填 描述
codigo string 是 唯一客户代码(最多40个字符)
tipo number Yes 人员类型: 1=司法, 2=物理, 3=出口
cnpjCpf string Yes CPF(11位数字)或CNPJ(14位数字),仅限数字
nomeFantasia string 是 商品名/显示名(最多250个字符)
status 数字 是 0=未激活, 1=活动

验证规则:

  • 如果 tipo 是 2 (物理), cnpjCpf 必须是有效的11位CPF。
  • 如果 tipo 是 1 (陪审团)或 3 (出口) cnpjCpf 必须是有效的14位CNPJ。
  • 没有格式化字符(点、破折号、斜线),只有数字。

post_lead

通过以下方式在Hub中创建新线索 /leads 终点。

字段 类型 必填 描述
codigo string 是 唯一潜在客户代码(最多100个字符)
email string 是 有效的电子邮件地址(最多250个字符)
nomeFantasia string 否 商品名/显示名称(最多250个字符)
razaoSocial string 否 法定/公司名称(最多250个字符)
telefone string 否 电话号码(最多20个字符)
celular string 否 手机号码(最多20个字符)
origem string 否 潜在客户来源: OUTROS 或 RD_STATION

项目结构

src/
├── index.ts              # Entry point, stdio transport setup
├── server.ts             # MCP server instance
├── tools/
│   └── customer/
│       ├── handler.ts    # post_customer tool registration and logic
│       └── typings.ts    # Request/response type definitions
└── utils/
    ├── constants.ts      # Shared constants (status, person types, regex)
    └── hub.http.ts       # HTTP client for Hub API requests
build/                    # Compiled output (generated by npm run build)

发展

# Compile TypeScript
npm run build

# The output binary is at build/index.js

许可证

国际学生中心