← Index

io.github.YogiAdhik/civicrm-mcp

io.github.YogiAdhik/civicrm-mcp·v0.1.2·Other
Quality Score
80
/100

Model Context Protocol server for CiviCRM — AuthX-first, schema-introspected, write-gated.

§01  Install
Claude Desktop (claude_desktop_config.json)
{
  "mcpServers": {
    "civicrm-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "civicrm-mcp"
      ],
      "env": {
        "CIVICRM_BASE_URL": "<civicrm_base_url>",
        "CIVICRM_API_KEY": "<your-civicrm_api_key>",
        "CIVICRM_CMS": "drupal",
        "CIVICRM_SITE_KEY": "<your-civicrm_site_key>",
        "CIVICRM_AUTH_MODE": "authx",
        "CIVICRM_ALLOW_WRITES": "false",
        "CIVICRM_ALLOW_DELETES": "false"
      }
    }
  }
}
Cursor (.cursor/mcp.json)
{
  "mcpServers": {
    "civicrm-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "civicrm-mcp"
      ],
      "env": {
        "CIVICRM_BASE_URL": "<civicrm_base_url>",
        "CIVICRM_API_KEY": "<your-civicrm_api_key>",
        "CIVICRM_CMS": "drupal",
        "CIVICRM_SITE_KEY": "<your-civicrm_site_key>",
        "CIVICRM_AUTH_MODE": "authx",
        "CIVICRM_ALLOW_WRITES": "false",
        "CIVICRM_ALLOW_DELETES": "false"
      }
    }
  }
}
Cline (cline_mcp_settings.json)
npx -y civicrm-mcp
§02  Environment variables
CIVICRM_BASE_URL
required

Base URL of the CiviCRM install, e.g. https://crm.example.org. No trailing slash.

CIVICRM_API_KEY
requiredsecret

API key of the contact the server authenticates as. Keep it on a dedicated 'MCP Bot' contact with minimum permissions.

CIVICRM_CMS

CMS host: drupal, wordpress, standalone, or backdrop.

CIVICRM_SITE_KEY
secret

Optional — only needed if the site enables the AuthX site-key guard.

CIVICRM_AUTH_MODE

authx (default, recommended) or legacy for pre-5.36 installs.

CIVICRM_ALLOW_WRITES

Set to 'true' to enable create / update / save / submit actions. Off by default.

CIVICRM_ALLOW_DELETES

Set to 'true' to enable delete / replace actions. Off by default.

§03  MCP Quality Score  ·  methodology
freshness
25
completeness
10
installability
25
documentation
15
stability
5
§04  Alternatives in Other