Skip to main content
Glama

Vtiger CRM MCP Server

by harsh-softsolvers
GitHub
TypeScript
OverviewInspectNewEndpointsSchemaRelated ServersReviewsScore
Need Help?View Source CodeReport Issue

Vtiger CRM MCP Server

A Model Context Protocol (MCP) server that provides tools for interacting with Vtiger CRM through its REST API. Supports both stdio and HTTP/WebSocket transports for local and remote usage.

Features

  • Dual Transport Support: stdio for local usage, HTTP/WebSocket for remote access

  • Complete Vtiger CRM API integration

  • TypeScript support with full type safety

  • Comprehensive CRUD operations

  • Advanced querying and search capabilities

  • Proper authentication handling

  • Error handling and validation

  • Health check and info endpoints

  • CORS support for web clients

Installation

  1. Clone the repository

  2. Install dependencies:

    npm install

  3. Configure environment variables:

    cp .env.example .env # Edit .env with your Vtiger credentials and server settings

  4. Build the project:

    npm run build

Usage

Option 1: Stdio Transport (Local/Process-based)

npm run start:stdio # or node dist/index.js --transport=stdio

Option 2: HTTP Transport (Remote/Network-based)

npm run start:http # or node dist/index.js --transport=http --port=3001 --host=0.0.0.0

Development Mode

npm run dev # Default stdio npm run dev:http # HTTP on port 3001

Configuration

Environment Variables

# Vtiger CRM Configuration VTIGER_BASE_URL=https://your-vtiger-instance.com VTIGER_USERNAME=your-username VTIGER_ACCESS_KEY=your-access-key # MCP Server Configuration MCP_TRANSPORT=http # 'stdio' or 'http' MCP_PORT=3001 # Port for HTTP transport MCP_HOST=0.0.0.0 # Host for HTTP transport

Command Line Arguments

node dist/index.js --transport=http --port=3001 --host=localhost

Remote Access Endpoints

When running with HTTP transport:

  • WebSocket MCP Endpoint: ws://your-server:3001/mcp

  • Health Check: http://your-server:3001/health

  • Server Info: http://your-server:3001/info

MCP Client Configuration

For Local MCP Clients (stdio)

{ "mcpServers": { "vtiger-crm": { "command": "node", "args": ["/path/to/vtiger-mcp-server/dist/index.js", "--transport=stdio"] } } }

For Remote MCP Clients (WebSocket)

{ "mcpServers": { "vtiger-crm": { "url": "ws://your-server.com:3001/mcp" } } }

Available Tools

  • vtiger_list_modules: List all available modules

  • vtiger_describe_module: Get module metadata and fields

  • vtiger_create_record: Create new records

  • vtiger_retrieve_record: Get specific records by ID

  • vtiger_update_record: Update existing records

  • vtiger_delete_record: Delete records

  • vtiger_query: Execute custom queries

  • vtiger_search: Search across modules

  • vtiger_sync: Get modified records

API Examples

Using the MCP Client (Programmatic)

import { createVtigerClient } from './src/client/mcp-client.js'; // Connect to remote MCP server const client = await createVtigerClient('ws://localhost:3001/mcp'); // List available tools const tools = await client.listTools(); // Create a lead const result = await client.callTool('vtiger_create_record', { module: 'Leads', data: { firstname: 'John', lastname: 'Doe', email: 'john.doe@example.com', company: 'Example Corp' } }); // Search for contacts const contacts = await client.callTool('vtiger_search', { searchValue: 'john', module: 'Contacts' }); await client.disconnect();

Health Check

curl http://localhost:3001/health

Response:

{ "status": "ok", "timestamp": "2025-01-01T12:00:00.000Z" }

Server Info

curl http://localhost:3001/info

Response:

{ "name": "vtiger-mcp-server", "version": "1.0.0", "capabilities": { "tools": {} } }

Deployment

Docker Deployment

Create a Dockerfile:

FROM node:18-alpine WORKDIR /app COPY package*.json ./ RUN npm ci --only=production COPY dist ./dist COPY .env .env EXPOSE 3001 CMD ["node", "dist/index.js", "--transport=http", "--port=3001", "--host=0.0.0.0"]

PM2 Deployment

{ "name": "vtiger-mcp-server", "script": "dist/index.js", "args": ["--transport=http", "--port=3001"], "env": { "NODE_ENV": "production", "MCP_TRANSPORT": "http", "MCP_PORT": "3001" } }

Nginx Reverse Proxy

upstream vtiger_mcp { server localhost:3001; } server { listen 80; server_name your-domain.com; location /mcp { proxy_pass http://vtiger_mcp; proxy_http_version 1.1; proxy_set_header Upgrade $http_upgrade; proxy_set_header Connection "upgrade"; proxy_set_header Host $host; proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header X-Forwarded-Proto $scheme; } location /health { proxy_pass http://vtiger_mcp; } location /info { proxy_pass http://vtiger_mcp; } }

Security Considerations

  1. Network Security: When exposing via HTTP, ensure proper firewall rules

  2. HTTPS: Use HTTPS/WSS in production with proper SSL certificates

  3. Authentication: Consider adding authentication middleware for HTTP transport

  4. CORS: Configure CORS appropriately for your use case

  5. Rate Limiting: Implement rate limiting for production deployments

Monitoring

The server provides several monitoring endpoints:

  • /health - Basic health check

  • /info - Server information and capabilities

  • Console logs for connection events and errors

Development

npm run dev # Development with hot reload (stdio) npm run dev:http # Development with hot reload (HTTP) npm run type-check # Type checking only npm run build # Production build

Troubleshooting

Common Issues

  1. Connection Refused: Check if the server is running and port is accessible

  2. Authentication Errors: Verify Vtiger credentials in .env

  3. WebSocket Connection Failed: Ensure firewall allows WebSocket connections

  4. CORS Issues: Check CORS configuration for web clients

Debug Mode

Set DEBUG=1 environment variable for detailed logging:

DEBUG=1 npm run start:http

This server cannot be installed

-
security - not tested
F
license - not found
-
quality - not tested

How are these scores calculated?

A Model Context Protocol server that provides tools for interacting with Vtiger CRM through its REST API.

  1. Features
    1. Installation
      1. Usage
        1. Option 1: Stdio Transport (Local/Process-based)
        2. Option 2: HTTP Transport (Remote/Network-based)
        3. Development Mode
      2. Configuration
        1. Environment Variables
        2. Command Line Arguments
      3. Remote Access Endpoints
        1. MCP Client Configuration
          1. For Local MCP Clients (stdio)
          2. For Remote MCP Clients (WebSocket)
        2. Available Tools
          1. API Examples
            1. Using the MCP Client (Programmatic)
            2. Health Check
            3. Server Info
          2. Deployment
            1. Docker Deployment
            2. PM2 Deployment
            3. Nginx Reverse Proxy
          3. Security Considerations
            1. Monitoring
              1. Development
                1. Troubleshooting
                  1. Common Issues
                  2. Debug Mode

                Related MCP Servers

                • Salesforce
                  salesforce-mcp-server

                  kablewy
                  A
                  security
                  F
                  license
                  A
                  quality
                  A Model Context Protocol server implementation for interacting with Salesforce through its REST API.
                  Last updated -
                  17
                  42

                • ConnectWise API Gateway MCP Server

                  jasondsmith72
                  -
                  security
                  F
                  license
                  -
                  quality
                  A Model Context Protocol server that provides a comprehensive interface for interacting with the ConnectWise Manage API, simplifying API discovery, execution, and management for both developers and AI assistants.
                  Last updated -
                  0
                  5
                  • Linux
                  • Apple

                • Harvest Time Tracking MCP Server

                  CodifyAG
                  -
                  security
                  A
                  license
                  -
                  quality
                  A Model Context Protocol server implementation that wraps Harvest's REST API, enabling seamless interaction with Harvest's time tracking, client, project, and reporting features through MCP clients.
                  Last updated -
                  3
                  MIT License

                • Ollama_MCP_Guidance

                  ShadovvSinger
                  -
                  security
                  A
                  license
                  -
                  quality
                  A Model Context Protocol server that provides standardized interfaces for interacting with Ollama API, offering JSON responses, error handling, and intelligent guidance for LLM-based API calls.
                  Last updated -
                  MIT License
                  • Linux
                  • Apple

                View all related MCP servers

                New MCP Servers

                MCP directory API

                We provide all the information about MCP servers via our MCP API.

                curl -X GET 'https://glama.ai/api/mcp/v1/servers/harsh-softsolvers/mcp'

                If you have feedback or need assistance with the MCP directory API, please join our Discord server