- Home
- MCP servers
- Bitrix24
Bitrix24
- typescript
21
GitHub Stars
typescript
Language
5 months ago
First Indexed
2 months ago
Catalog Refreshed
Documentation & install
Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.
Installation
Add the following to your MCP client configuration file.
Configuration
View docs{
"mcpServers": {
"gunnit-bitrix24-mcp-server": {
"command": "node",
"args": [
"/path/to/your/bitrix24-mcp-server/build/index.js"
],
"env": {
"BITRIX24_WEBHOOK_URL": "https://your-domain.bitrix24.com/rest/USER_ID/WEBHOOK_CODE/"
}
}
}
}You set up and run a TypeScript MCP server that lets AI agents interact with your Bitrix24 CRM. It exposes a comprehensive set of tools to manage Contacts, Deals, Tasks, Leads, Companies, Users, and more, while handling authentication, rate limits, and error scenarios to keep your integration reliable.
How to use
You connect to the MCP server from an MCP client (such as Claude Desktop) and issue actions that map to Bitrix24 CRM operations. Use the available tools to create, read, update, and list CRM entities, perform advanced searches, and monitor sales team activities. You can rely on the server to enforce rate limits, validate inputs, and return structured results or error messages for handling in your automation flows.
How to install
# Prerequisites
node version
Follow these concrete steps to install and run the MCP server locally. Use a real path for your project in place of the placeholders.
- Clone the project and install dependencies
- Prepare your environment variables
- Build the project
- Run tests
- Start the server in your environment
Configuration and startup notes
The server relies on a Bitrix24 webhook URL to connect to your Bitrix24 instance. You should set it in an environment variable named BITRIX24_WEBHOOK_URL. Other common settings, such as the Node environment and log level, can be tuned via environment variables as well.
Environment variables you will configure include:
Claude Desktop Integration
{
"mcpServers": {
"bitrix24": {
"command": "node",
"args": ["/path/to/your/bitrix24-mcp-server/build/index.js"],
"env": {
"BITRIX24_WEBHOOK_URL": "https://your-domain.bitrix24.com/rest/USER_ID/WEBHOOK_CODE/"
}
}
}
}
Usage examples
Create a new contact, then create a deal linked to that contact, or manage tasks by specifying titles, priorities, and due dates. Use the tool names exactly as listed to perform the respective operations within your MCP client.
Development
If you want to contribute, you can explore the project structure, add new tools, and run the standard development commands. You will build, test, and start the server from your development environment.
Security considerations
Protect your webhook URL and avoid committing environment configuration files. The server enforces rate limiting and emphasizes careful handling of error information to prevent exposing sensitive data.
Troubleshooting
If you encounter webhook validation failures, verify the webhook URL and permissions. For module or dependency issues, re-install, rebuild, and ensure the runtime environment matches the required versions.
Available tools
bitrix24_create_contact
Create a new contact in Bitrix24 with provided fields.
bitrix24_get_contact
Retrieve a contact by its ID.
bitrix24_list_contacts
List contacts with filtering options.
bitrix24_update_contact
Update an existing contact by ID.
bitrix24_create_deal
Create a new deal and associate it with relevant entities.
bitrix24_get_deal
Retrieve a deal by ID.
bitrix24_list_deals
List deals with filtering options.
bitrix24_update_deal
Update an existing deal by ID.
bitrix24_create_task
Create a new task and link to CRM entities.
bitrix24_get_task
Retrieve a task by ID.
bitrix24_list_tasks
List tasks with filtering options.
bitrix24_update_task
Update an existing task by ID.
bitrix24_get_user
Get user information by ID.
bitrix24_get_all_users
Get all users with names and details.
bitrix24_resolve_user_names
Resolve user IDs to user names.
bitrix24_get_contacts_with_user_names
Get contacts with user names resolved.
bitrix24_get_deals_with_user_names
Get deals with user names resolved.
bitrix24_get_leads_with_user_names
Get leads with user names resolved.
bitrix24_get_companies_with_user_names
Get companies with user names resolved.
bitrix24_create_lead
Create a new lead.
bitrix24_get_lead
Retrieve lead by ID.
bitrix24_list_leads
List leads with filtering options.
bitrix24_get_latest_leads
Get most recent leads.
bitrix24_get_leads_from_date_range
Get leads from a specific date range.
bitrix24_update_lead
Update an existing lead.
bitrix24_create_company
Create a new company.
bitrix24_get_company
Retrieve a company by ID.
bitrix24_list_companies
List companies with filtering options.
bitrix24_get_latest_companies
Get most recent companies.
bitrix24_get_companies_from_date_range
Get companies from a specific date range.
bitrix24_update_company
Update an existing company.
bitrix24_get_deal_pipelines
Get all deal pipelines/categories.
bitrix24_get_deal_stages
Get deal stages for pipelines.
bitrix24_filter_deals_by_pipeline
Filter deals by pipeline.
bitrix24_filter_deals_by_budget
Filter deals by budget range.
bitrix24_filter_deals_by_status
Filter deals by stage/status.
bitrix24_search_crm
Search across CRM entities.
bitrix24_get_current_user
Get current user information.
bitrix24_validate_webhook
Validate webhook connection.
bitrix24_diagnose_permissions
Diagnose webhook permissions.
bitrix24_check_crm_settings
Check CRM settings and configuration.
bitrix24_test_leads_api
Test leads API endpoints.
bitrix24_monitor_user_activities
Monitor user activities (calls, emails, timeline interactions, response times).
bitrix24_get_user_performance_summary
Get performance summary with deal metrics and conversion rates.
bitrix24_analyze_account_performance
Analyze performance for specific accounts.
bitrix24_compare_user_performance
Compare performance metrics between multiple users.
bitrix24_track_deal_progression
Track deal progression through pipeline stages with timing analysis.
bitrix24_monitor_sales_activities
Monitor sales-related activities (tasks, follow-ups, meetings).
bitrix24_generate_sales_report
Generate comprehensive sales reports with customizable metrics.
bitrix24_get_team_dashboard
Get real-time team performance dashboard.
bitrix24_analyze_customer_engagement
Analyze customer engagement patterns and relationship health.
bitrix24_forecast_performance
Generate performance forecasts and predictive analytics.