Bitrix24 MCP Server

Bitrix24 MCP Server

site icon
2025.03.28 1
JavaScriptCRM集成业务自动化交流协作
Bitrix24 MCP Server 是一个基于 MCP (Model-Controller-Presenter) 架构的服务器应用程序,提供与 Bitrix24 CRM 交互的 REST API。它作为中间层,允许语言模型通过结构化工具与 Bitrix24 API 进行交互,实现数据操作。
View on GitHub

Overview

基本能力

产品定位

Bitrix24 MCP Server 是一个中间件服务,旨在简化与 Bitrix24 CRM 的集成,提供结构化的 API 访问和数据操作能力。

核心功能

  • 提供对 Bitrix24 CRM 主要实体(交易、潜在客户、联系人、任务等)的完整访问
  • 数据格式化,便于客户端使用
  • 请求和响应的日志记录
  • 错误和异常处理
  • 支持 CORS,便于与前端应用交互
  • 提供丰富的 API 端点,涵盖 CRM 的各个方面

适用场景

  • 企业 CRM 系统集成
  • 自动化业务流程
  • 数据分析和报告生成
  • 客户关系管理工具开发

工具列表

  • getLeads: 获取潜在客户列表
  • getLead: 获取特定潜在客户信息
  • createLead: 创建新潜在客户
  • updateLead: 更新现有潜在客户
  • getDeals: 获取交易列表
  • getDeal: 获取特定交易信息
  • createDeal: 创建新交易
  • updateDeal: 更新现有交易
  • getContacts: 获取联系人列表
  • getContact: 获取特定联系人信息
  • getActivities: 获取活动列表
  • getActivity: 获取特定活动信息
  • createActivity: 创建新活动
  • updateActivity: 更新现有活动
  • getUsers: 获取用户列表
  • getUser: 获取特定用户信息
  • getTasks: 获取任务列表
  • getCallStatistics: 获取通话统计
  • getFile: 获取文件信息
  • addTimelineComment: 添加时间线评论
  • getCrmSummary: 获取 CRM 摘要信息
  • checkApiConnection: 检查 API 连接

常见问题解答

  • 如何设置日志级别? 通过 .env 文件中的 LOG_LEVEL 参数设置(error, warn, info, debug)
  • 如何处理错误? 服务器会返回相应的 HTTP 状态码和错误消息
  • 如何保证安全性? 建议使用 HTTPS,安全存储 webhook 令牌,并定期更新

使用教程

使用依赖

  • Node.js (版本 14.x 或更高)
  • npm (版本 6.x 或更高)
  • 访问 Bitrix24 并配置 webhook

安装教程

  1. 克隆仓库:
git clone https://github.com/your-username/bitrix24-mcp-server.git
cd bitrix24-mcp-server
  1. 安装依赖:
npm install
  1. 创建 .env 文件:
PORT=3000
BITRIX_DOMAIN=your-domain.bitrix24.ru
BITRIX_WEBHOOK_TOKEN=your-webhook-token
LOG_LEVEL=info
  1. 启动服务器:
npm start

调试方式

  • 检查日志输出
  • 使用 LOG_LEVEL=debug 获取详细调试信息
  • 测试 API 端点:
curl http://localhost:3000/api/deals

许可证

该项目遵循 MIT 开源许可条款。