@bitrix24/mcp-vibecode-api

MCP (Model Context Protocol) server for Bitrix24 via the Vibe API. Gives AI assistants 27 tools to work with CRM deals, contacts, tasks, files, users, and 24 other entity types — plus portal, key, and app management.

Quick Start

npx @bitrix24/mcp-vibecode-api --key vibe_app_xxx_yyy_zz

The server connects to https://vibecode.bitrix24.tech by default. Override with --api-url:

npx @bitrix24/mcp-vibecode-api --key vibe_app_xxx_yyy_zz --api-url http://localhost:8000

Claude Desktop Configuration

Add to ~/Library/Application Support/Claude/claude_desktop_config.json:

{
  "mcpServers": {
    "vibe-bitrix24": {
      "command": "npx",
      "args": ["-y", "@bitrix24/mcp-vibecode-api", "--key", "vibe_app_xxx_yyy_zz"]
    }
  }
}

For a self-hosted API:

{
  "mcpServers": {
    "vibe-bitrix24": {
      "command": "npx",
      "args": [
        "-y", "@bitrix24/mcp-vibecode-api",
        "--key", "vibe_app_xxx_yyy_zz",
        "--api-url", "http://localhost:8000"
      ]
    }
  }
}

Environment Variables

Instead of CLI flags, you can set environment variables:

| Variable | Flag | Description | |----------|------|-------------| | VIBE_API_KEY | --key | API key (required) | | VIBE_API_URL | --api-url | API base URL (default: https://vibecode.bitrix24.tech) |

Tools (27)

Entity Tools (10)

| Tool | Description | |------|-------------| | discover | Get API schema — summary of all 29 entities or full field definitions for one entity | | get_fields | Get live field definitions including user-defined custom fields (UF_*) | | list_entities | List entities with filters, sorting, pagination. Auto-paginates when limit > 50 | | get_entity | Get a single entity by ID | | create_entity | Create a new entity | | update_entity | Update an existing entity (partial update) | | delete_entity | Delete an entity by ID | | search_entities | Search with MongoDB-style filters ($gt, $gte, $lt, $lte, $ne, $contains, $in) | | batch_entities | Batch create, update, and/or delete entities (max 500 items) | | aggregate_entities | Aggregation: count, sum, avg, min, max with groupBy and filter |

Portal Tools (1)

| Tool | Description | |------|-------------| | list_portals | List all portals accessible with the management key |

Key Tools (6)

| Tool | Description | |------|-------------| | list_keys | List all API keys for a portal | | get_key | Get a specific API key by ID | | create_key | Create a new API key with scopes, IP whitelist, expiration | | update_key | Update an existing API key | | delete_key | Delete an API key permanently | | rotate_key | Rotate an API key, generating a new secret |

App Tools (7)

| Tool | Description | |------|-------------| | list_apps | List all apps, optionally filtered by status | | get_app | Get a specific app by ID | | create_app | Create a new Bitrix24 app | | update_app | Update an existing app | | delete_app | Delete an app permanently | | publish_app | Publish an app company-wide | | unpublish_app | Revert an app to draft status |

Deployment Tools (3)

| Tool | Description | |------|-------------| | list_deployments | List all deployments for an app | | deploy_app | Deploy an app to portal or marketplace | | undeploy_app | Remove a specific deployment |

Supported Entities (29)

deals, contacts, companies, leads, quotes, activities, products, product-sections, statuses, currencies, requisites, timelines, invoices, tasks, task-comments, calendar-events, files, folders, storages, users, departments, workgroups, chats, messages, list-elements, catalog-products, orders, sites, pages.

Features

• Auto-pagination — requests with limit > 50 automatically paginate through all results
• Custom fields — get_fields returns user-defined fields (UF_*) alongside static schema fields
• MongoDB-style filters — $gt, $gte, $lt, $lte, $ne, $contains, $in operators in search
• Date windowing — large searches auto-split into date windows for reliability (disable with autoWindow: false)
• Cross-entity batch — combine up to 50 calls across different entities in one request via /v1/batch
• Batch search — action: "search" in batch auto-paginates each sub-call individually (up to 5000 records)
• Aggregation — count, sum, avg, min, max with groupBy support

Transports

• stdio (default) — for Claude Desktop, Cursor, and other MCP clients
• HTTP — --http flag starts an HTTP server on port 3001 (override with --port)

# HTTP mode
npx @bitrix24/mcp-vibecode-api --key vibe_app_xxx --http --port 4000

Resources

The server exposes a vibe://api-reference resource with the full API reference documentation.

Prompts

• create-bitrix24-app — step-by-step guide for creating, publishing, and deploying a Bitrix24 app

API Key Types

• App key (vibe_app_...) — for entity CRUD, search, batch, aggregation, and app management
• Management key (vibe_live_...) — for portal and key management

Get your API key at vibecode.bitrix24.tech.

License

MIT