mcp-rest-doc

This MCP server exposes Bitrix24 REST API documentation through an HTTP-based MCP endpoint. It provides tools to perform semantic search over the Bitrix24 REST docs, inspect method details, fetch documentation articles, and view event/Webhook information. You can query using the bitrix-search tool to find relevant methods, then drill down with bitrix-method-details to learn about parameters, examples, and potential errors. If you need background articles or API references, use bitrix-article-details and bitrix-event-details to retrieve full content and metadata. The server is designed to help AI assistants fetch authoritative REST API information on demand, without requiring a live browser or large prompt dumps.

Prerequisites:

• Node.js (v14+ recommended) and npm/yarn available on your system
• Internet access for fetching the MCP server package via npx

Install and run (one-off options):

• Quick start using npx (no local install):

  1. Ensure Node.js is installed
  2. Run: npx -y io.github.bitrix24/bitrix-mcp-rest
  3. The MCP server will start and expose an HTTP API endpoint at the default MCP address used by your client configuration

• Persistent/local install (if you want to pin a version):

  1. Ensure Node.js is installed
  2. Create a project directory and run: npm init -y
  3. Install via npx with a specific version: npm exec -y io.github.bitrix24/bitrix-mcp-rest@<version>
  4. Start the server as instructed by the package (often: node dist/server.js or npm run start)

Configuration tips:

• Use the provided mcp.json or add the server under mcpServers with the bitrix-mcp-rest key as shown in the mcp_config example.
• If your Bitrix24 REST calls require authentication, supply a token via the BITRIX_API_TOKEN environment variable.
• Validate the endpoint URL in your MCP client to ensure it points to the running server (default or customized host/port).

Tips and common considerations:

• The server exposes tools: bitrix-search, bitrix-method-details, bitrix-article-details, and bitrix-event-details. Use bitrix-search first to locate a method, then fetch detailed parameters and examples with bitrix-method-details.
• If your MCP client supports HTTP transports, configure the endpoint URL to the hosted mcp endpoint (for example, https://mcp-dev.bitrix24.com/mcp).
• No API key is required for general documentation access, but some Bitrix24 endpoints in examples may require authentication; supply BITRIX_API_TOKEN if needed.
• If you encounter timeouts or malformed responses, verify your network access to Bitrix24 documentation and, if using a local install, ensure dependencies are up to date.