#MCP для AI
Вайбкод публикует два MCP-сервера для AI-агентов — подходят для Claude Desktop, Claude Code, Cursor, Codex CLI, Windsurf, Gemini CLI и любого другого клиента с поддержкой Model Context Protocol.
mcp-vibe-api— инструменты для работы с Битрикс24 через Vibe API.mcp-docs— справочник по REST-методам Битрикс24.
Установка mcp-vibe-api | Инструменты (53) | HTTP-транспорт | mcp-docs | Безопасность
#Что можно делать через MCP
Подборка диалогов с AI-агентом и инструментов, которые агент реально вызывает. Помогает оценить возможности mcp-vibe-api и подобрать набор скоупов для ключа.
#Аналитика по сделкам
Пользователь: Покажи сумму сделок в работе по каждому ответственному за последний месяц.
Агент по очереди вызывает:
aggregate_entitiesдля сущностиdealsс фильтром поcloseDate, агрегатомsumпо полюamountи группировкой поassignedById.list_entitiesдля сущностиusers— чтобы заменить идентификаторы на имена сотрудников.
Скоуп ключа: crm, user.
#Создание и публикация бота
Пользователь: Зарегистрируй бота с именем «Помощник» и пришли тестовое сообщение в чат с моим коллегой.
Агент по очереди вызывает:
manage_botс действиемregister— создаёт бота на портале.manage_botс действиемget_events— получает идентификатор диалога с коллегой из входящего события.manage_bot_messagesс действиемsend— отправляет приветственное сообщение в нужный диалог.
Скоуп ключа: imbot.
#Развёртывание приложения на сервере
Пользователь: Подними новый сервер у Yandex и выкатишь туда архив с приложением.
Агент по очереди вызывает:
manage_serverс действиямиlist_providers,list_plans,list_regions,list_images— собирает каталог.manage_serverс действиемcreate— создаёт сервер в выбранной конфигурации.manage_serverс действиемget— ждёт, пока статус станетRUNNINGиCONNECTED.manage_server_deployс действиемdeploy— запускает конвейер развёртывания (загрузка архива, установка, systemd, проверка работоспособности).manage_server_deployс действиемlogs— читает журналы при ошибках.
Скоуп ключа: vibe:infra.
#Подключение собственного провайдера AI
Пользователь: Добавь мой ключ OpenAI и сделай тестовый запрос к gpt-4o.
Агент по очереди вызывает:
manage_ai_credentialsс действиемlist_providers— выясняет идентификатор провайдера OpenAI.manage_ai_credentialsс действиемcreate— сохраняет ключ; провайдер проверяется до записи и возвращает422 CREDENTIAL_INVALID, если ключ не работает.ai_chatс действиемchatи параметромmodel: "openai/gpt-4o"— отправляет тестовый запрос через AI Router.
Скоуп ключа: vibe:ai.
#Оставить запрос в поддержку через AI
Пользователь: Эндпоинт
/v1/deals/aggregateиногда возвращает пустой ответ — заведи тикет с подробностями.
Агент по очереди вызывает:
get_me— забирает идентификатор портала и текущий тариф для поляcontext.manage_feedbackс действиемcreate— отправляет тикет с категориейBUG, заголовком, описанием воспроизведения и сериализованнымcontext(эндпоинт, тело запроса, код ответа).
Скоуп ключа: создание тикетов доступно любому ключу.
#mcp-vibe-api
Сервер, который даёт AI-агенту доступ к Битрикс24 через Vibe API. Дальше — установка, параметры запуска, инструменты, Resources, Prompts и HTTP-транспорт.
#Установка
Пакет `@bitrix24/mcp-vibecode-api`. После установки доступна команда mcp-vibe-api. Нужен Node.js версии 18 или выше — подойдёт любая актуальная LTS-сборка (18, 20, 22).
npm install -g @bitrix24/mcp-vibecode-api
#Регистрация в клиенте через CLI
Если клиент умеет управлять MCP-серверами через консоль, конфиг-файл редактировать не нужно — достаточно одной команды.
Claude Code:
claude mcp add vibecode -- mcp-vibe-api --key vibe_api_your_key_here
Команда добавит сервер в локальный конфиг текущего пользователя. Чтобы поделиться настройкой со всем проектом, добавьте флаг -s project — конфиг попадёт в .mcp.json репозитория. Управлять списком: claude mcp list, claude mcp remove vibecode.
Codex CLI:
codex mcp add vibecode -- mcp-vibe-api --key vibe_api_your_key_here
Запись попадёт в ~/.codex/config.toml. Передать API-ключ через переменную окружения вместо аргумента: codex mcp add vibecode --env VIBE_API_KEY=vibe_api_your_key_here -- mcp-vibe-api. Для проектного scope создайте .codex/config.toml в корне репозитория и пропишите блок [mcp_servers.vibecode] напрямую.
Gemini CLI:
gemini mcp add vibecode mcp-vibe-api --key vibe_api_your_key_here
Запись попадёт в ~/.gemini/settings.json. Передать ключ через переменную окружения: gemini mcp add -e VIBE_API_KEY=vibe_api_your_key_here vibecode mcp-vibe-api. Для проектного scope используйте .gemini/settings.json в корне репозитория.
#Регистрация через конфиг-файл
Claude Desktop (~/Library/Application Support/Claude/claude_desktop_config.json на macOS, %APPDATA%\Claude\claude_desktop_config.json на Windows):
{
"mcpServers": {
"vibecode": {
"command": "mcp-vibe-api",
"args": ["--key", "vibe_api_your_key_here"]
}
}
}
Cursor (.cursor/mcp.json в корне проекта):
{
"mcpServers": {
"vibecode": {
"command": "mcp-vibe-api",
"args": ["--key", "vibe_api_your_key_here"]
}
}
}
Codex CLI (~/.codex/config.toml):
[mcp_servers.vibecode]
command = "mcp-vibe-api"
args = ["--key", "vibe_api_your_key_here"]
#Запуск без глобальной установки
Если глобально установить пакет нельзя, замените mcp-vibe-api на npx -y @bitrix24/mcp-vibecode-api в любом конфиге выше. Пример для Claude Desktop:
{
"mcpServers": {
"vibecode": {
"command": "npx",
"args": ["-y", "@bitrix24/mcp-vibecode-api", "--key", "vibe_api_your_key_here"]
}
}
}
#Параметры запуска
Ключ и базовый URL передаются флагами командной строки или через переменные окружения. При коллизии флаг побеждает.
| Флаг | Переменная окружения | По умолчанию | Описание |
|---|---|---|---|
--key <api-key> |
VIBE_API_KEY |
— | API-ключ Вайбкод (vibe_api_... или vibe_app_...) |
--api-url <url> |
VIBE_API_URL |
https://vibecode.bitrix24.tech |
Базовый URL Vibe API |
--http |
— | выключен | Включить HTTP-транспорт вместо stdio |
--http-token <token> |
VIBE_MCP_HTTP_TOKEN |
— | Bearer-токен для HTTP-транспорта (обязателен с --http) |
--host <host> |
— | 127.0.0.1 |
Адрес для HTTP-транспорта |
--port <port> |
— | 3001 |
TCP-порт для HTTP-транспорта |
--allowed-origins <csv> |
— | пусто | Список разрешённых браузерных Origin, через запятую |
--max-body-kb <n> |
— | 256 |
Лимит тела запроса в килобайтах |
--rate-limit <rpm> |
— | 300 |
Лимит запросов в минуту на IP |
-h, --help |
— | — | Показать справку |
-v, --version |
— | — | Показать версию пакета |
Установка ключа через переменную окружения, чтобы не хранить его в конфигах:
export VIBE_API_KEY="vibe_api_your_key_here"
mcp-vibe-api
#Доступ по типу ключа
mcp-vibe-api работает с двумя типами ключей Вайбкод и при старте запрашивает /v1/me, чтобы определить тип. Дальше клиенту отдаются только те инструменты, которые ключ может использовать.
| Тип ключа | Какие инструменты доступны |
|---|---|
vibe_api_... или vibe_app_... (ключ портала) |
Данные Битрикс24, AI, сборка приложений, служебные |
vibe_live_... (управляющий ключ) |
Платформенное управление, служебные |
В описании каждой группы инструментов ниже указан тип ключа, который к ней подходит.
#Инструменты (53)
Все инструменты возвращают JSON. Для специализированных эндпоинтов есть типизированные обёртки — используйте их вместо call_api, когда они доступны: подсказки по параметрам и валидация выше. Инструменты сгруппированы в пять кластеров по типу задачи.
#Данные Битрикс24 (27) — ключ портала
Чтение и запись данных портала: CRM-сущности, чаты и боты, расширения для CRM, телефония, файлы, бизнес-процессы, рабочее время. Подходит большинству задач AI-агента.
#Сущности CRM и других модулей (10)
Покрывают единый CRUD-интерфейс над 40+ сущностями Битрикс24 — от сделок и контактов до задач, файлов, документов и записей смарт-процессов.
| Инструмент | Описание |
|---|---|
discover |
Список сущностей и их полей из OpenAPI-схемы |
get_fields |
Поля сущности с учётом пользовательских полей UF_* |
list_entities |
Список записей с фильтрацией, сортировкой, автопагинацией при limit > 50 |
get_entity |
Запись по ID |
create_entity |
Создание записи |
update_entity |
Частичное обновление записи |
delete_entity |
Удаление записи |
search_entities |
Поиск с операторами $gt, $gte, $lt, $lte, $ne, $contains, $in |
batch_entities |
Массовое создание, обновление и удаление до 500 записей за вызов |
aggregate_entities |
Агрегация: count, sum, avg, min, max с группировкой через groupBy |
Поддерживаемые сущности: deals, contacts, companies, leads, quotes, activities, products, product-sections, statuses, currencies, deal-categories, requisites, timelines, invoices, items, smart-processes, tasks, calendar-events, files, folders, storages, users, departments, workgroups, chats, list-elements, catalog-products, catalog-sections, catalog-prices, orders, order-statuses, basket-items, payments, sites, pages, doc-templates, documents, bookings, bizproc-templates, openline-configs, telephony-lines и другие.
#Чаты (1)
| Инструмент | Действия |
|---|---|
manage_chat |
list_recent, find, get, send_message, read_messages, create, add_users, bulk_messages |
Скоуп: im. Управляет чатами и сообщениями на стороне пользователя; для чатов, принадлежащих боту, нужен manage_bot_chat.
#Боты (3)
Управление ботами на платформе Битрикс24 — регистрация, чаты, обмен сообщениями. Скоуп ключа: imbot.
| Инструмент | Действия |
|---|---|
manage_bot |
register, unregister, update, list, get, get_events |
manage_bot_chat |
create, get, update, leave, add_user, remove_user, set_owner |
manage_bot_messages |
send, edit, delete, add_reaction, remove_reaction, read, get_history, send_typing |
#CRM-расширения и работа с порталом (12)
| Инструмент | Действия |
|---|---|
manage_workday |
open, close, pause, status, settings, schedule — учёт рабочего времени. Скоуп: timeman |
manage_workflow |
start, list, terminate, send_event — бизнес-процессы. Скоуп: bizproc |
send_notification |
Push-уведомление пользователю Битрикс24. Скоуп: im |
manage_call |
register, finish, auto_call, callback, statistics, voices — телефония и автообзвон с TTS. Скоуп: telephony |
manage_trigger |
fire, list — CRM-триггеры автоматизации. Скоуп: bizproc |
manage_timeline_log |
create, list, get, delete, add_note, get_note, delete_note, pin, unpin, bind, unbind, get_bindings — записи в таймлайне CRM-сущностей. Скоуп: crm |
manage_warehouse |
list, get, create, delete, get_stock — склады и остатки. Скоуп: catalog |
manage_post |
list, create, update, delete, share, add_comment — посты в живой ленте. Скоуп: log |
manage_userfield |
list, get, types, create, update, delete — пользовательские поля в фиксированных CRM-сущностях и смарт-процессах. Скоуп: crm |
manage_task_time |
list, get, add, update, delete — учёт времени по задачам. Скоуп: task |
crm_extras |
stage_history, find_duplicates — история стадий и поиск дубликатов. Скоуп: crm |
manage_file |
upload, download — загрузка и скачивание файлов в Битрикс24.Диске. Скоуп: disk |
#Универсальный вызов Vibe API (1)
| Инструмент | Описание |
|---|---|
call_api |
Произвольный HTTP-вызов к Vibe API: method, path, body, query. Запасной канал для эндпоинтов без типизированной обёртки |
Пример вызова: call_api({ method: "GET", path: "/v1/calls/statistics" }).
#AI (2) — ключ портала
Подключение AI-моделей через AI Router и управление BYOK-учётными данными. Скоуп: vibe:ai.
| Инструмент | Действия |
|---|---|
ai_chat |
list_models, chat — OpenAI-совместимые chat completions через /v1/chat/completions; модель по умолчанию — бесплатная bitrix/bitrixgpt-5.5 |
manage_ai_credentials |
list, create, update, delete, test, usage, list_providers — управление BYOK-учётными данными для подключения сторонних AI-провайдеров. Создание и обновление проверяют ключ перед сохранением и возвращают 422 CREDENTIAL_INVALID при ошибке |
#Сборка приложений (14) — ключ портала
Создание приложений Битрикс24, развёртывание серверной части на облачных VM, настройка плейсментов в интерфейсе портала.
#Инфраструктура (3)
Облачные серверы для приложений и Black Hole-туннели. Скоуп: vibe:infra.
| Инструмент | Действия |
|---|---|
manage_server |
Каталог: list_providers, list_plans, list_regions, list_images. Жизненный цикл: create, list, get, delete, get_ssh. Состояние: start, stop, reboot, wake, sleep_now, refresh. Операции: metrics, set_port, set_sleep, set_mode, repair, repair_status |
manage_server_deploy |
deploy, exec, upload, logs, clear_lock — конвейер развёртывания с шагами stop → clean → download → runtime → install → env → pre_start → systemd → start → healthcheck |
manage_server_access |
list_access, add_access, remove_access, b24_users_search — списки доступа Black Hole с автодополнением пользователей Битрикс24 |
#Приложения (5)
| Инструмент | Описание |
|---|---|
list_apps |
Список приложений, опциональный фильтр по статусу |
get_app |
Приложение по ID |
create_app |
Создание приложения |
update_app |
Обновление приложения |
delete_app |
Удаление приложения |
#Публикация и развёртывание приложений (5)
| Инструмент | Описание |
|---|---|
publish_app |
Публикация приложения для всего портала |
unpublish_app |
Возврат приложения в черновик |
list_deployments |
Список развёртываний приложения |
deploy_app |
Развёртывание приложения на портал или в каталог приложений |
undeploy_app |
Удаление конкретного развёртывания |
#Плейсменты (1)
| Инструмент | Действия |
|---|---|
manage_placements |
list_bound, list_available, bind, unbind — встройка приложения в интерфейс Битрикс24. Для IM-плейсментов (IM_SIDEBAR, IM_NAVIGATION, IM_TEXTAREA) обязателен параметр options.iconName — проверяется на стороне клиента до отправки запроса |
Скоуп: placement.
#Платформенное управление (8) — управляющий ключ
Эта группа доступна только управляющим ключам Вайбкод (формат vibe_live_...).
| Инструмент | Описание |
|---|---|
list_portals |
Список порталов, доступных по управляющему ключу |
list_keys |
Список API-ключей портала |
get_key |
Ключ по ID |
create_key |
Создание ключа со скоупами, IP-вайтлистом и сроком действия |
update_key |
Изменение ключа |
delete_key |
Удаление ключа |
rotate_key |
Ротация секрета ключа |
manage_feedback |
create, list, get, update, comment — обращения через /v1/feedback. Управляющий ключ работает со всеми порталами; для ключа портала это создание и чтение собственных тикетов, а с дополнительным скоупом vibe:feedback — также обновление и комментирование |
#Служебные (2) — любой ключ
Доступны и ключу портала, и управляющему.
| Инструмент | Описание |
|---|---|
get_me |
Снимок текущего ключа: владелец, портал, тариф, состояние пробного периода, capabilities. Параметр sections сужает ответ; refresh: 'tariff' принудительно перепроверяет тариф через Битрикс24 |
check_for_updates |
Проверка наличия обновлений mcp-vibe-api в реестре npm. Возвращает текущую и последнюю версии, команду обновления |
#Resources
URI вида vibe://... отдают справочные материалы для AI-агента.
| URI | Описание |
|---|---|
vibe://api-reference |
Полный справочник Vibe API в формате Markdown |
vibe://entity/{plural} |
Справочник по конкретной сущности — например vibe://entity/deals, vibe://entity/tasks |
vibe://tariff-gate |
Карта 402-ошибок тарифного шлюза, пробного периода и баланса с подсказками userMessage / alternatives / hint |
vibe://error-codes |
Каталог кодов ошибок Vibe API и форма их ответа |
#Prompts
Готовые мульти-шаговые подсказки для AI-агента. Активируются клиентом по имени.
| Имя | Описание |
|---|---|
create-bitrix24-app |
Сценарий создания, публикации и развёртывания приложения для Битрикс24 |
deploy-app-step-by-step |
Развёртывание приложения на сервере: пробуждение, загрузка, выполнение команд, проверка работоспособности |
diagnose-server-issue |
Диагностика проблем сервера: статус, метрики, журналы, варианты восстановления |
upgrade-from-trial |
Объяснение блокировок тарифного шлюза и пути перехода на коммерческий тариф |
#HTTP-транспорт
Помимо stdio (используется по умолчанию) mcp-vibe-api поддерживает HTTP-транспорт. Подходит для серверных интеграций, где stdio неудобен.
mcp-vibe-api \
--key vibe_api_your_key_here \
--http \
--http-token "$(openssl rand -hex 32)" \
--allowed-origins https://your-client.example.com
Клиент отправляет POST http://127.0.0.1:3001/mcp с заголовками:
Authorization: Bearer <token>
Content-Type: application/json
| Код ответа | Причина |
|---|---|
401 |
Отсутствует или некорректный Bearer-токен |
403 |
Не совпал заголовок Host, Origin не в списке разрешённых, либо OPTIONS без разрешённого Origin |
404 |
Путь отличается от /mcp |
405 |
Метод запроса отличается от POST или OPTIONS |
413 |
Тело запроса превышает --max-body-kb |
415 |
Content-Type отличается от application/json |
429 |
Превышен лимит запросов в минуту, ответ содержит Retry-After: 60 |
Сервер откажется стартовать, если --http указан без токена. Сами токены не пишутся в журналы — на старте указывается только их источник (флаг или переменная окружения).
#mcp-docs
Справочник по REST API Битрикс24: методы, скоупы, плейсменты, типы и категории приложений. Работает офлайн без API-ключа — все данные встроены в пакет.
#Установка
Пакет `@bitrix24/mcp-docs`. После установки доступна команда mcp-docs. API-ключ не нужен — справочник встроен в пакет и работает без сети.
npm install -g @bitrix24/mcp-docs
#Регистрация в клиенте
Через CLI:
claude mcp add bitrix24-docs -- mcp-docs
codex mcp add bitrix24-docs -- mcp-docs
gemini mcp add bitrix24-docs mcp-docs
Через конфиг-файл:
{
"mcpServers": {
"bitrix24-docs": {
"command": "mcp-docs"
}
}
}
#Инструменты (8)
| Инструмент | Описание |
|---|---|
search_docs |
Полнотекстовый поиск по справочнику |
get_rest_methods |
Список REST-методов с фильтром по скоупу или поисковому запросу |
get_method_detail |
Подробное описание метода: параметры, ответ, примеры |
get_scopes |
Список скоупов с описаниями |
get_placements |
Список UI-плейсментов с фильтром по модулю |
get_placement_detail |
Подробное описание плейсмента |
get_app_types |
Типы приложений Битрикс24 |
get_categories |
Категории приложений Битрикс24 |
Дополнительно сервер публикует ресурс с гайдом по REST API и промпт bitrix24-rest-intro — введение в REST и в синтаксис Вайбкод-прокси.
#Прямое использование Vibe API без MCP
Если MCP-клиент недоступен, дайте AI-модели API-ключ и ссылку на полный справочник:
Вот мой API-ключ Вайбкод: vibe_api_your_key_here
Полная документация: https://vibecode.bitrix24.tech/llms-full.txt
Опишите вашу задачу...
mcp-vibe-api подключается к любому клиенту с поддержкой Model Context Protocol — Claude Desktop, Claude Code, Cursor, Codex CLI, Windsurf, Gemini CLI и другим. Прямой ключ без MCP подойдёт даже клиентам без поддержки протокола, например ChatGPT.
#Безопасность
- Передавайте API-ключ через переменную окружения
VIBE_API_KEYили флаг--key— не вписывайте ключ в скрипты, репозитории и публичные конфиги. - Создавайте отдельный ключ для каждого AI-агента и оставляйте только нужные скоупы — ключи
vibe_api_...поддерживают список скоупов и срок действия. - Для серверных сценариев настраивайте IP-вайтлист и фиксированный срок жизни ключа.
- В HTTP-транспорте используйте Bearer-токен из
--http-tokenилиVIBE_MCP_HTTP_TOKENи оставляйте--host 127.0.0.1, если внешний доступ не нужен. - Если ключ скомпрометирован — отзовите его в разделе ключей и создайте новый.
#Смотрите также
- Управление ключами — типы ключей Вайбкод и их скоупы
- Эндпоинты Vibe API — единый CRUD над сущностями Битрикс24
- AI Router — модели и BYOK-провайдеры
- Обратная связь — отправка сообщений о проблемах через
/v1/feedback