使用说明

项目简介

Bitrix24 MCP服务器是一个基于Model Context Protocol (MCP) 构建的应用后端，旨在连接大型语言模型 (LLM) 与 Bitrix24 CRM系统。它允许LLM安全地访问和操作您的Bitrix24数据，例如联系人和交易，从而实现更智能的CRM应用集成。通过标准化的MCP协议，服务器提供了一组预定义的“工具”和“资源”，使得LLM可以像调用本地函数一样与CRM系统进行交互。

主要功能点

Bitrix24 CRM集成: 无缝对接Bitrix24，让LLM能够访问和利用CRM中的核心数据。
标准化MCP协议: 采用业界标准的Model Context Protocol，确保与各类MCP客户端和LLM应用的兼容性。
工具 (Tools): 提供一系列预置功能，如联系人搜索、交易状态更新等，让LLM具备操作CRM的能力。
资源 (Resources): 允许LLM以结构化的方式获取CRM数据，如联系人详情、活跃交易列表等。
提示词模板 (Prompts): 内置常用操作的提示词模板，辅助LLM生成更有效的CRM交互指令。
易于扩展: 采用模块化设计，方便添加对Bitrix24新实体或MCP工具/资源的支持。

安装步骤

克隆仓库:

git clone https://github.com/kartochka/bitrix24-mcp
cd bitrix24-mcp

创建并激活虚拟环境:

python -m venv venv
source venv/bin/activate  # 或 venv\Scripts\activate for Windows

安装依赖:

pip install -r requirements.txt

服务器配置

MCP客户端需要配置以下信息以连接到Bitrix24 MCP服务器：

{
  "server name": "Bitrix24 MCP Server",
  "command": "python",
  "args": ["main.py"],
  "env": {
    "BITRIX_WEBHOOK_URL": "您的Bitrix24 Webhook URL"
    // "LOG_LEVEL": "INFO" // 可选，设置日志级别 (DEBUG, INFO, WARNING, ERROR, CRITICAL)，默认为INFO
  },
  "description": "连接到Bitrix24 MCP服务器，访问CRM数据。"
}

配置参数说明:

'server name': 服务器的名称，用于在客户端标识连接。
'command': 启动服务器的命令，这里使用 'python'。
'args': 启动命令的参数，指定服务器入口文件为 'main.py'。
'env': 环境变量配置。
- 'BITRIX_WEBHOOK_URL': 必需。您的Bitrix24传入Webhook URL。请替换为您的实际Webhook URL，确保Webhook拥有必要的CRM权限。
- 'LOG_LEVEL': 可选。设置服务器日志输出级别，默认为 'INFO'。可以根据需要调整为 'DEBUG' 或 'WARNING' 等。

获取Bitrix24 Webhook URL:

登录您的Bitrix24账户。
进入“应用商店” -> “开发者资源” -> “传入Webhook”。
创建一个新的传入Webhook，并赋予至少 'crm' 权限。
复制生成的Webhook URL，并将其配置到 'BITRIX_WEBHOOK_URL' 环境变量中。

基本使用方法

配置环境变量: 根据 “服务器配置” 章节的说明，设置 'BITRIX_WEBHOOK_URL' 环境变量。您可以通过导出环境变量或创建 '.env' 文件的方式进行配置。
启动服务器: 在项目根目录下运行命令：
```
python main.py
```
服务器启动后，将在终端输出日志信息，包括注册的MCP工具和资源。
使用MCP客户端连接: 使用任何兼容MCP协议的客户端（例如 Mental Model Lab 提供的 MCP 客户端），根据 “服务器配置” 章节生成的JSON配置信息，配置客户端连接到Bitrix24 MCP服务器。
通过客户端与Bitrix24交互: 在MCP客户端中，您可以使用预定义的工具 (如 'tool://get_contact', 'tool://search_deals') 和资源 (如 'contact://{contact_id}', 'deals://active') 与Bitrix24 CRM系统进行交互。具体工具和资源的使用方法请参考仓库的 'README.md' 文档中 “使用” 章节的详细描述。

关键词