零售CRM集成服务器

RetailCRM MCP Server是一个用于与RetailCRM API集成的服务器,允许AI助手如Claude访问CRM系统中的订单、客户和商品数据。

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

使用说明

零售CRM MCP服务器

MCP(Model Context Protocol)与RetailCrm API集成的服务器。允许Claude和其他AI助理访问您的CRM系统中的订单、客户和产品。

🚀 在线部署(1分钟)

建议: 铁路-最好的免费选择

  • ⚡ 点击按钮 “部署在铁路上” 上方
  • 🔑 添加RetailCrm密钥API
  • 🌐 获取工作URL: https://your-app.railway.app
  • 🎯 在AI Studio中使用: https://your-app.railway.app/manifest

🚀 快速启动

通过NPM安装

npm install -g retailcrm-mcp

或本地安装

git clone https://github.com/yourusername/retailcrm-mcp.git
cd retailcrm-mcp
npm install
npm run build

⚙️ 设置

1.从RetailCrm获取API密钥

  1. 登录到RetailCrm面板
  2. 转到 设置 → 集成 → API访问密钥
  3. 创建具有订单、客户和商品读取权限的新密钥
  4. 复制密钥

2.创建配置文件

创建文件 ~/.retailcrm-mcp/.env:

mkdir -p ~/.retailcrm-mcp
cat > ~/.retailcrm-mcp/.env << 'EOF'
RETAILCRM_URL=https://your-account.retailcrm.ru
RETAILCRM_API_KEY=your_api_key_here
MCP_PORT=3002
EOF

或者只是创建 .env 项目文件夹中的文件:

RETAILCRM_URL=https://your-account.retailcrm.ru
RETAILCRM_API_KEY=your_api_key_here
MCP_PORT=3002

3.配置(2个选项)

选项A:Claude Desktop(本地)

打开Claude Desktop配置文件:

macOS:

~/Library/Application\ Support/Claude/claude_desktop_config.json

窗户:

%APPDATA%/Claude/claude_desktop_config.json

添加:

{
  "mcpServers": {
    "retailcrm": {
      "command": "retailcrm-mcp"
    }
  }
}

选项B:外部HTTP服务器(用于AI Studio和其他工具)

启动HTTP服务器:

npm run server

服务器将在:

  • 健康:http://localhost:3002/health
  • 显示:http://localhost:3002/manifest
  • 工具:http://localhost:3002/tools

对于AI Studio:

  1. 启动服务器: npm run server
  2. 在AI Studio中,使用URL: http://localhost:3002/manifest
  3. AI Studio将自动检测所有可用工具

对于其他HTTP客户端:

# Получить список инструментов
curl http://localhost:3002/tools

# Проверить статус сервера
curl http://localhost:3002/health

# Получить манифест
curl http://localhost:3002/manifest

4.重新启动Claude Desktop(如果您使用选项A)

完全关闭并重新打开Claude Desktop。

💬 使用

您现在可以向Claude询问RetailCrm的数据:

  • “显示最后10个订单”
  • “找到12345号订单”
  • 显示客户信息email@example.com"
  • “我们有多少订单?”
  • “展示X类产品”

🛠️ 可用工具

订单

  • get_orders -获取订单列表(过滤和剥离)
  • get_order -通过ID获取特定订单信息
  • create_order -创建新订单

客户

  • get_customers -获取客户列表
  • get_customer -通过ID获取客户信息
  • create_customer 创建新客户
  • update_customer -更新客户端数据

商品

  • get_products -获取产品清单
  • get_product -通过ID获取产品信息

目录和统计

  • get_statistics -获取订单/客户统计数据
  • get_order_statuses -获取订单状态
  • get_delivery_types -获取送货类型
  • get_payment_types -获取付款类型
  • get_sites -获取网站
  • get_order_history -获取订单更改历史记录
  • get_tasks -获取任务列表
  • create_task -创建任务

🔧 开发

项目装配

npm run build

开发运行

# Для Claude Desktop (stdio)
npm run dev

# Для внешнего HTTP сервера (AI Studio)
npm run server

MCP Inspector测试

npx @modelcontextprotocol/inspector node build/index.js

HTTP服务器测试

# Запустить сервер
npm run server

# Проверить эндпоинты в другой терминал
curl http://localhost:3002/health
curl http://localhost:3002/manifest
curl http://localhost:3002/tools

📝 要求

  • Node.js 18+
  • 来自RetailCRM的API密钥
  • Claude Desktop(与Claude集成)

📄 许可证

MIT许可证文件 许可证

🤝 支持

如果您有任何问题:

  1. 验证API密钥是否处于活动状态并具有正确的权限
  2. 确保RetailCrm URL正确(结尾没有斜杠)
  3. 检查Claude Desktop日志
  4. 在GitHub上创建一个问题

🔗 参考文献