README.md
A comprehensive MCP server for Bitrix24 CRM integration
Bitrix24 MCP Server
A comprehensive Model Context Protocol (MCP) server for Bitrix24 CRM integration, enabling AI agents to seamlessly interact with your Bitrix24 instance through a powerful set of tools.
🚀 Features
- Complete CRM Management: Create, read, update, and list contacts, deals, and tasks
- Advanced Search: Search across all CRM entities with flexible filtering
- Rate Limiting: Built-in rate limiting to respect Bitrix24 API limits
- Type Safety: Full TypeScript implementation with comprehensive type definitions
- Error Handling: Robust error handling and validation
- Easy Integration: Simple setup with Claude Desktop and other MCP-compatible clients
📋 Available Tools
Contact Management
bitrix24_create_contact- Create new contactsbitrix24_get_contact- Retrieve contact by IDbitrix24_list_contacts- List contacts with filteringbitrix24_update_contact- Update existing contacts
Deal Management
bitrix24_create_deal- Create new dealsbitrix24_get_deal- Retrieve deal by IDbitrix24_list_deals- List deals with filteringbitrix24_update_deal- Update existing deals
Task Management
bitrix24_create_task- Create new tasksbitrix24_get_task- Retrieve task by IDbitrix24_list_tasks- List tasks with filteringbitrix24_update_task- Update existing tasks
User Management
bitrix24_get_user- Get user information by IDbitrix24_get_all_users- Get all users in the system with names and detailsbitrix24_resolve_user_names- Resolve user IDs to user namesbitrix24_get_contacts_with_user_names- Get contacts with user names resolvedbitrix24_get_deals_with_user_names- Get deals with user names resolvedbitrix24_get_leads_with_user_names- Get leads with user names resolvedbitrix24_get_companies_with_user_names- Get companies with user names resolved
Lead Management
bitrix24_create_lead- Create new leadsbitrix24_get_lead- Retrieve lead by IDbitrix24_list_leads- List leads with filteringbitrix24_get_latest_leads- Get most recent leadsbitrix24_get_leads_from_date_range- Get leads from specific date rangebitrix24_update_lead- Update existing leads
Company Management
bitrix24_create_company- Create new companiesbitrix24_get_company- Retrieve company by IDbitrix24_list_companies- List companies with filteringbitrix24_get_latest_companies- Get most recent companiesbitrix24_get_companies_from_date_range- Get companies from specific date rangebitrix24_update_company- Update existing companies
Enhanced Deal Filtering
bitrix24_get_deal_pipelines- Get all deal pipelines/categoriesbitrix24_get_deal_stages- Get deal stages for pipelinesbitrix24_filter_deals_by_pipeline- Filter deals by pipelinebitrix24_filter_deals_by_budget- Filter deals by budget rangebitrix24_filter_deals_by_status- Filter deals by stage/status
Utilities
bitrix24_search_crm- Search across CRM entitiesbitrix24_get_current_user- Get current user infobitrix24_validate_webhook- Validate webhook connectionbitrix24_diagnose_permissions- Diagnose webhook permissionsbitrix24_check_crm_settings- Check CRM settings and configurationbitrix24_test_leads_api- Test leads API endpoints
Sales Team Monitoring
bitrix24_monitor_user_activities- Monitor user activities (calls, emails, timeline interactions, response times)bitrix24_get_user_performance_summary- Get comprehensive performance summary with deal metrics and conversion ratesbitrix24_analyze_account_performance- Analyze performance for specific accounts (companies/contacts)bitrix24_compare_user_performance- Compare performance metrics between multiple usersbitrix24_track_deal_progression- Track deal progression through pipeline stages with timing analysisbitrix24_monitor_sales_activities- Monitor sales-related activities (tasks, follow-ups, meetings)bitrix24_generate_sales_report- Generate comprehensive sales reports with customizable metricsbitrix24_get_team_dashboard- Get real-time team performance dashboardbitrix24_analyze_customer_engagement- Analyze customer engagement patterns and relationship healthbitrix24_forecast_performance- Generate performance forecasts and predictive analytics
🛠️ Installation
Prerequisites
- Node.js 18+
- npm or yarn
- Bitrix24 webhook URL
Setup
- Clone and install dependencies:
git clone <repository-url>
cd bitrix24-mcp-server
npm install
- Configure environment:
cp .env.example .env
# Edit .env with your Bitrix24 webhook URL
- Build the project:
npm run build
- Test the connection:
npm test
⚙️ Configuration
Environment Variables
Create a .env file with the following variables:
BITRIX24_WEBHOOK_URL=https://your-domain.bitrix2
Tools (6)
bitrix24_create_contactCreate new contacts in Bitrix24.bitrix24_list_dealsList deals with filtering capabilities.bitrix24_create_taskCreate new tasks in the CRM.bitrix24_search_crmSearch across all CRM entities.bitrix24_get_user_performance_summaryGet comprehensive performance summary with deal metrics and conversion rates.bitrix24_generate_sales_reportGenerate comprehensive sales reports with customizable metrics.Environment Variables
BITRIX24_WEBHOOK_URLrequiredThe webhook URL for your Bitrix24 instanceConfiguration
claude_desktop_config.json
{"mcpServers": {"bitrix24": {"command": "node", "args": ["/path/to/bitrix24-mcp-server/build/index.js"], "env": {"BITRIX24_WEBHOOK_URL": "https://your-domain.bitrix24.com/rest/1/your-webhook-key/"}}}}Try it
→List all active deals in the current pipeline.
→Create a new contact for John Doe with email john@example.com.
→Generate a performance summary for the sales team for this month.
→Search for the company 'Acme Corp' in the CRM.
→Track the progression of deal ID 123 through the pipeline stages.