AI导哈

Bitrix24 REST API文档服务

Bitrix MCP是一个提供Bitrix24 REST API文档访问的服务，使AI助手能够直接、准确地获取最新的API信息，减少集成错误。

  • by bitrix24
  • 云端部署
  • 7 星标
  • 更新于
在 GitHub 查看 bitrix24/mcp-rest-doc

使用说明

Bitrix MCP REST API文档

Bitrix MCP是提供AI助手的官方服务器 直接、最新地访问Bitrix24 REST API文档.
助手可以直接从Bitrix24文档中查询此服务器并获得权威答案，而不是依赖假定的方法名称或参数。

当开发人员要求AI助手为Bitrix24编写集成代码时，该模型可能会发明方法或传递不正确的参数。使用MCP，助手可以以Bitrix24 REST API专家的身份调用该服务器，并在 实际文件而非假设.

为什么使用Bitrix MCP

Bitrix MCP适用于需要使用Bitrix24的AI助手 无需记忆整个REST API:

  • 准确、最新的答案 –助手直接从Bitrix24文档中查询此MCP服务器以获取当前的REST方法、字段和示例，从而检索经过验证的方法和参数。
  • 无需网络搜索即可工作 –本地或受限模型（无互联网搜索）仍然可以通过MCP工具访问Bitrix24 REST API表面。
  • 减少上下文管理 –无需将大型文档粘贴到提示中，也无需维护您自己的API引用嵌入；助手按需取文件。
  • 更少的集成错误 –助手通过语义搜索找到正确的方法，首先检查参数/示例/错误，然后生成与真实API匹配的代码，而不是猜测。

示例：一位开发人员要求助手“在Bitrix24中创建一个包含产品行的CRM交易。”
助理：

  • 电话 bitrix-search 找到 crm.deal.add 及相关方法
  • 然后调用 bitrix-method-details 获取参数和示例
    基于此，它生成正确的REST调用 没有不正确或缺失的字段.

特性

  • Bitrix24 REST文档的语义搜索
  • 详细方法检查 包含参数、示例、错误、返回值和URL
  • 文章和活动文件 检索
  • MCP原生HTTP服务器 与支持HTTP传输的任何MCP客户端兼容

可用工具

bitrix搜索

描述:
使用自然语言查询搜索Bitrix24方法和文档文章。
返回格式化的结果列表，并可选地返回建议的后续工具调用。

参数:

  • query （必填）：自然语言搜索查询。
  • top_k （可选）：搜索结果的最大数量。

响应:

  • 匹配的Bitrix24 REST方法、事件和文档文章的纯文本列表。
  • 每行包含一个名称和简短描述，按相关性排序。
  • 如果未找到任何内容，该工具将返回一个空字符串。

bitrix方法详细信息

描述:
返回Bitrix24 REST方法的详细信息。
典型用法是在找到方法后通过 bitrix-search.

参数:

  • method （必填）：精确的REST方法名称，例如。 crm.deal.add.
  • field （可选，默认 all)：其中之一：
    • all
    • name
    • description
    • params
    • example
    • errors
    • returns
    • url
  • filter （可选）：附加筛选器字符串（特定于搜索服务）。

响应:

  • 对于 field="all"：多节纯文本摘要，包括：
    • 方法名称、模块、类别、作用域
    • 描述和文档URL
    • 参数、返回值、错误和示例
  • 他人的 field 值：仅请求的部分（例如，参数列表，仅URL，仅示例）。
  • 如果找不到该方法：一条简短的错误消息，建议调用 bitrix-search 第一。

bitrix文章详细信息

描述:
返回非方法Bitrix24文档文章的全文和元数据。

参数:

  • title_or_hint （必填）：文章标题或唯一标识提示（例如 bitrix-search 结果）。
  • top_k （可选）：要聚合的候选文档的最大数量。

响应:

  • 带有文章标题、可选元数据（模块、类别、URL）、描述部分和完整内容正文的结构化标记文本。
  • 如果找不到匹配的文章，则返回一条简短的“找不到文章”消息。

bitrix事件详细信息

描述:
返回Bitrix24事件（webhooks、回调等）的文档。

参数:

  • title_or_hint （必填）：事件名称或唯一标识片段。
  • top_k （可选）：要聚合的最大候选人数。

响应:

  • 格式与 bitrix-article-details，但专注于事件文档：
    • 标题、元数据、描述和从Bitrix24文档组装的内容。
  • 如果没有匹配的事件文档可用，则返回一条简短的错误消息。

配置

Bitrix MCP可作为托管HTTP端点使用。无需API密钥或本地设置，只需配置您的MCP客户端即可连接到我们的端点。

光标

添加到您的 mcp.json:

{
  "mcpServers": {
    "bitrix-mcp-rest": {
      "url": "https://mcp-dev.bitrix24.com/mcp"
    }
  }
}

或者使用此README顶部的一键安装徽章。

VS Code

添加到您的 .vscode/mcp.json:

{
  "servers": {
    "bitrix-mcp-rest": {
      "type": "http",
      "url": "https://mcp-dev.bitrix24.com/mcp"
    }
  }
}

或者使用此README顶部的一键安装徽章。

克劳德桌面

添加到您的 claude_desktop_config.json:

{
  "mcpServers": {
    "bitrix-mcp-rest": {
      "type": "http",
      "url": "https://mcp-dev.bitrix24.com/mcp"
    }
  }
}

其他MCP客户端

对于任何支持HTTP传输的MCP兼容客户端，请使用：

  • 统一资源定位符: https://mcp-dev.bitrix24.com/mcp
  • 类型: http

如需支持，请通过以下方式联系Bitrix24 Support24 Helpdesk 或者在此MCP服务器的GitHub存储库中提交问题。

相关 MCP