MCP-сервер для работы с REST API Битрикс24

MCP-сервер Битрикс24 — это сервер Model Context Protocol, который предоставляет AI-инструментам доступ к актуальной REST-документации Битрикс24.

Если подключить MCP-сервер, модель:

  • обращается к реальной документации Битрикс24
  • не выдумывает методы REST API
  • генерирует корректный код интеграций и приложений

Сервер отдает только документацию: доступа к данным Битрикс24 у него нет, и вызовы методов он не выполняет.

Когда нужно использовать MCP

Подключайте MCP-сервер Битрикс24, если вы:

  • разрабатываете чат-бота для Битрикс24, в том числе с помощью ChatGPT
  • создаете приложение или интеграцию через REST API и генерируете код через Claude, Copilot или другой AI-инструмент
  • настраиваете автоматизацию, AI-агента или no-code сценарий

MCP-сервер снимает и типовые сбои модели, которая работает без документации:

  • модель выдает несуществующие методы REST API Битрикс24
  • модель открывает ссылки документации Битрикс24 и получает 404

MCP-сервер не нужен, если задача не связана с REST API Битрикс24 или если вы создаете приложение в Битрикс24 Вайбкод — там AI-агент получает документацию платформы сам.

Как работает MCP в Битрикс24

В обмене участвуют три стороны:

  • AI-инструмент — редактор кода, CLI или десктопное приложение, в котором вы пишете запрос: Cursor, Codex, Claude Code, Copilot Chat и другие
  • MCP-клиент — встроенная в AI-инструмент часть, которая по протоколу MCP запрашивает у сервера список инструментов и вызывает их
  • MCP-сервер Битрикс24 — сервер b24-dev-mcp, который отдает данные из документации REST API

Порядок обработки запроса:

  1. Вы отправляете запрос AI-инструменту на естественном языке.

  2. Модель определяет, что для ответа нужны данные о методах Битрикс24, и вызывает инструмент MCP-сервера.

  3. Сервер возвращает данные из документации: описание метода, список параметров, допустимые значения, ошибки и примеры кода.

  4. Модель формирует ответ и код на основе полученных данных, а не на основе того, что она запомнила при обучении.

Такой порядок дает три эффекта:

  • модель получает актуальные методы и поля API под конкретную задачу

  • данные приходят структурированными, а не свободным текстом

  • в коде становится меньше ошибок и правок

Инструменты сервера

Сервер предоставляет пять инструментов. Поиск возвращает точные имена методов и заголовки материалов — остальные инструменты принимают их и отдают полное описание.

Инструмент

Что делает

bitrix-search

Ищет по документации запросом на естественном языке и возвращает список совпадений: имя, тип и краткое описание. Тип ограничивается параметром doc_type — списком значений method, event, other, app_development_docs. Число совпадений задает параметр limit

bitrix-method-details

Возвращает описание метода по точному имени: параметры, возвращаемые данные, ошибки и примеры кода. Параметр field ограничивает состав ответа, filter сужает выборку параметров или примеров

bitrix-event-details

Возвращает описание события по точному заголовку из результата bitrix-search

bitrix-article-details

Возвращает статью документации по точному заголовку из результата bitrix-search

bitrix-app-development-doc-details

Возвращает материал по разработке приложений по точному заголовку из результата bitrix-search

Отдельных MCP-ресурсов и готовых промптов сервер не публикует — все данные доступны только через эти инструменты.

Транспортный протокол

MCP-сервер Битрикс24 работает по протоколу Streamable HTTP. Адрес один и тот же для всех клиентов: https://mcp-dev.bitrix24.tech/mcp. Устаревший транспорт HTTP+SSE не поддерживается — отдельного адреса вида /sse у сервера нет.

Ответы сервер передает кадрами Server-Sent Events, поэтому клиент должен принимать оба типа контента: application/json и text/event-stream. Запрос, в заголовке Accept которого указан только application/json, сервер отклоняет с кодом 406.

Примечание

Если клиент спрашивает тип транспорта, выбирайте http. В конфигурации VS Code он задается полем "type": "http".

Что нужно для подключения

  • Авторизация. Сервер доступен без авторизации: ключ, токен или вебхук для подключения не нужны.

  • Доступ к данным. Сервер не читает и не изменяет лиды, сделки, задачи и файлы в Битрикс24. Запросы к Битрикс24 отправляет код, который вы получили от AI-инструмента.

  • Секреты. Не передавайте в запросах к серверу вебхуки, токены и пароли: инструментам сервера они не нужны.

  • Права и scope. На работу сервера права пользователя и scope приложения не влияют. Проверять их нужно при реальных вызовах: требования указаны на странице каждого метода.

  • Окружение. Нужен AI-инструмент с поддержкой удаленных MCP-серверов по Streamable HTTP и исходящий доступ по HTTPS к mcp-dev.bitrix24.tech.

Как подключить MCP-сервер

Укажите адрес сервера https://mcp-dev.bitrix24.tech/mcp в настройках среды разработки. Ниже — порядок настройки для распространенных AI-инструментов.

Codex CLI

  1. Добавьте MCP-сервер командой:

    codex mcp add b24-dev-mcp --url https://mcp-dev.bitrix24.tech/mcp
    
  2. Проверьте, что сервер появился в списке, командой codex mcp list.

  3. Составляйте запросы по правилу для Codex из раздела Как формулировать запросы.

Codex в VS Code

Команда codex mcp add из предыдущего раздела пишет в этот же файл, поэтому выбирайте один способ из двух.

  1. Откройте файл ~/.codex/config.toml.

  2. Добавьте конфигурацию MCP-сервера:

    [mcp_servers.b24-dev-mcp]
    url = "https://mcp-dev.bitrix24.tech/mcp"
    
  3. Перезапустите VS Code или переподключите сессию Codex.

  4. Составляйте запросы по правилу для Codex из раздела Как формулировать запросы.

Cursor

  1. Откройте File > Preferences > Cursor Settings > Tools & MCP > New MCP server. Cursor откроет глобальный файл ~/.cursor/mcp.json. Чтобы настроить сервер только для одного проекта, используйте файл .cursor/mcp.json в корне этого проекта.

  2. Добавьте сервер новым ключом в объект mcpServers файла mcp.json:

    {
      "mcpServers": {
        "b24-dev-mcp": {
          "url": "https://mcp-dev.bitrix24.tech/mcp",
          "timeout": 30000
        }
      }
    }
    
  3. Сохраните файл. На странице File > Preferences > Cursor Settings > Tools & MCP рядом с сервером появится зеленый индикатор и список доступных инструментов.

  4. При составлении запроса добавьте файл mcp.json в контекст.

Альтернативный способ добавления MCP. Нажмите кнопку ниже — Cursor откроется и предложит добавить сервер с уже заполненной конфигурацией.

Add b24-dev-mcp MCP server to Cursor

GitHub Copilot Chat, VS Code

  1. Для настройки используйте инструкцию GitHub по подключению MCP-серверов к Copilot Chat.

  2. Создайте файл .vscode/mcp.json в корне проекта. Содержимое файла:

    {
      "servers": {
        "b24-dev-mcp": {
          "url": "https://mcp-dev.bitrix24.tech/mcp",
          "type": "http"
        }
      },
      "inputs": []
    }
    
  3. Запустите сервер кнопкой Start, которая появится в файле .vscode/mcp.json.

  4. Выберите сервер b24-dev-mcp в списке инструментов чата. Copilot будет запрашивать контекст у MCP при генерации кода.

Claude Desktop

  1. Перейдите в Settings > Connectors.

  2. Нажмите Add custom connector.

  3. Заполните поля:

    • Name: b24-dev-mcp

    • URL: https://mcp-dev.bitrix24.tech/mcp

  4. Сохраните настройки. Коннектор b24-dev-mcp появится в списке Settings > Connectors.

Claude Code CLI

  1. Выполните команду:

    claude mcp add --transport http b24-dev-mcp https://mcp-dev.bitrix24.tech/mcp
    
  2. Проверьте, что сервер добавлен, командой claude mcp list.

  3. После подключения отправляйте запросы как обычно.

Gemini CLI

  1. Добавьте MCP-сервер командой:

    gemini mcp add --transport http b24-dev-mcp https://mcp-dev.bitrix24.tech/mcp
    
  2. Проверьте, что сервер появился в списке, командой gemini mcp list.

  3. После подключения отправляйте запросы как обычно.

Google Antigravity

  1. Откройте меню MCP Store, нажав ... в верхней части панели агента.

  2. Нажмите Manage MCP Servers.

  3. Выберите View raw config.

  4. Добавьте в открывшийся файл mcp_config.json настройки подключения:

    {
      "mcpServers": {
        "b24-dev-mcp": {
          "serverUrl": "https://mcp-dev.bitrix24.tech/mcp"
        }
      }
    }
    
  5. Сохраните изменения. Сервер появится в списке Manage MCP Servers.

Как проверить подключение

Что сервер добавлен, показывает шаг проверки в инструкции для вашего AI-инструмента. Что он действительно работает, показывает контрольный запрос.

Контрольный запрос. Отправьте AI-инструменту: «Используй MCP-сервер Битрикс24 и покажи параметры метода crm.item.add». В ответе должны быть названы обязательные параметры метода — entityTypeId и fields. Общие рассуждения о CRM без имен параметров означают, что модель отвечает по памяти и к серверу не обращалась. Этот признак работает в любом клиенте.

Список инструментов. В клиентах с графическим интерфейсом рядом с сервером выводятся его инструменты: их должно быть пять, и все имена начинаются с bitrix-. Команды вида mcp list в CLI такой список не выводят — они показывают сами серверы и состояние подключения.

Если ни один признак не сработал, разбирайтесь по разделу Если MCP-сервер не отвечает.

Как формулировать запросы

MCP-сервер предоставляет модели актуальные данные REST API Битрикс24, но AI-инструменты вызывают его по-разному.

AI-инструмент

Когда вызывается MCP

Что сделать в запросе

Codex CLI, Codex в VS Code

По явному указанию

Указать, что нужно использовать MCP-сервер и официальную документацию Битрикс24

Cursor

По содержимому контекста чата

Добавить файл mcp.json в контекст чата

GitHub Copilot Chat, VS Code

По выбранному набору инструментов

Выбрать сервер b24-dev-mcp в списке инструментов чата

Claude Desktop, Claude Code CLI, Gemini CLI, Google Antigravity

Автоматически

Ничего указывать не нужно

Универсальная формулировка, которая работает в любом из этих инструментов: «Напиши интеграцию для Битрикс24 через REST API. Для получения актуальных методов используй MCP-сервер и официальную документацию Битрикс24».

Примеры запросов под конкретные задачи:

  • «Найди метод REST API Битрикс24 для создания лида и покажи пример запроса на JavaScript»

  • «Напиши curl-запрос для создания лида в Битрикс24 с полями имя, компания и телефон»

  • «Найди метод для обновления сделки в CRM и перечисли обязательные параметры»

  • «Какое событие Битрикс24 срабатывает при создании сделки и что приходит в его обработчик»

Если MCP-сервер не отвечает

Признак

Причина и решение

Клиент не видит сервер или показывает ошибку подключения

Клиент использует устаревший транспорт HTTP+SSE. Переключите его на Streamable HTTP — в конфигурации VS Code это поле "type": "http"

Сервер отвечает кодом 406

Клиент присылает заголовок Accept только с application/json. Он должен принимать и text/event-stream

Сервер в списке есть, но AI-инструмент отвечает без обращения к нему

Инструмент вызывает MCP только по явному указанию или по выбранному набору инструментов. Сверьтесь с таблицей в разделе Как формулировать запросы

Инструмент ответил not found или вернул не тот материал

Передано неточное имя. Сначала найдите объект через bitrix-search, затем запросите подробности по имени из результата поиска

Запрос не доходит до сервера

Закрыт исходящий HTTPS-доступ к mcp-dev.bitrix24.tech. Проверьте настройки сети или прокси

FAQ

Почему ChatGPT выдумывает методы REST API Битрикс24

У модели нет доступа к актуальной документации. MCP-сервер дает ей реальные методы API.

Как заставить Claude использовать документацию Битрикс24

Подключите MCP-сервер Битрикс24 — после этого модель обращается к документации напрямую.

Можно ли использовать MCP для генерации интеграций Битрикс24

Да. Через сервер модель получает методы REST API и генерирует корректный код.

Нужен ли Битрикс24, чтобы подключить MCP-сервер

Нет, сервер работает без него. Битрикс24 понадобится позже, когда вы запустите готовый код.

Чем MCP-сервер отличается от симулятора REST API

MCP-сервер отдает описание методов AI-инструменту на этапе написания кода. Симулятор REST API проверяет уже собранный вызов по машиночитаемой схеме и выполняет списочные методы на тестовых данных.

Что дальше

  • С чего начать — порядок изучения документации REST API, если вы работаете с ним впервые

  • Как вызывать методы REST API — авторизация, структура запроса и формат ответа для кода, который сгенерировал AI-инструмент

  • Справочник методов REST API — полный список разделов и методов, которые ищет MCP-сервер

  • Ограничения REST API — лимиты на количество и частоту запросов, которые нужно учитывать в интеграции

  • Коды ошибок — расшифровка ошибок, если сгенерированный запрос не отработал

  • Битрикс24 Вайбкод — создание приложения для Битрикс24 по описанию задачи, без написания кода вручную