Bitrix24 MCP

How to Install and Use Bitrix24 MCP

Bitrix24 MCP is an official server that gives AI assistants direct access to Bitrix24 REST API documentation. This means you get accurate, up-to-date information about Bitrix24 methods and parameters without guessing or searching the web. Here is a simple guide to help you install and start using Bitrix24 MCP.

Step 1: Understand What Bitrix24 MCP Does

Before you install, it's good to know why Bitrix24 MCP is useful. It helps you find the exact REST API methods and details by searching documentation on demand. This saves time and avoids mistakes when writing integration code for Bitrix24.

Step 2: Configure Your MCP Client

To use Bitrix24 MCP, you need to connect your MCP-compatible client to the Bitrix24 MCP server URL. This step requires adding a small configuration to your client setup.

For example, if you're using a general MCP client, add this JSON to your configuration file like mcp.json:

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

This code tells your client to connect to the Bitrix24 MCP HTTP server at the address shown.

Step 3: Configure MCP in VS Code

If you want to use Bitrix24 MCP inside Visual Studio Code, just add the following to .vscode/mcp.json:

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

This links VS Code's MCP feature to the Bitrix24 MCP server, so you can query the API documentation directly from your editor.

Step 4: Setup for Claude Desktop

For Claude Desktop users, Bitrix24 MCP can be added to your claude_desktop_config.json file as follows:

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

This allows Claude Desktop to send queries and get Bitrix24 API information instantly.

Step 5: Using Bitrix24 MCP Tools

Once connected, you can use Bitrix24 MCP’s built-in tools to find the API information you need:

• bitrix-search: Search Bitrix24 REST methods or articles by natural language.
• bitrix-method-details: Get full details about a specific REST method like crm.deal.add.
• bitrix-article-details: Access full text of documentation articles.
• bitrix-event-details: Look up events like webhooks or callbacks.

For example, to find a method:

{
  "tool": "bitrix-search",
  "parameters": {
    "query": "Create a CRM deal with products"
  }
}

Then request method details:

{
  "tool": "bitrix-method-details",
  "parameters": {
    "method": "crm.deal.add",
    "field": "all"
  }
}

These calls return accurate API docs for easier coding.

Final Notes

No API key or complex setup is required. Just add the Bitrix24 MCP server URL and start querying the documentation through your preferred MCP client. For problems or questions, you can reach Bitrix24 support or check the MCP GitHub page.

By following these steps, you can rely on Bitrix24 MCP to provide real-time, reliable API documentation right at your fingertips!