io.github.YogiAdhik/civicrm-mcp

MCP

by YogiAdhik · v0.1.2

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

mcplocal

MCP configuration

stdio

Command

npx -y civicrm-mcp@0.1.2

Environment

  • CIVICRM_BASE_URLrequired

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

  • CIVICRM_API_KEYrequiredsecret

    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_KEYsecret

    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.

Install in one click with Zurek

Browse here, install from the native macOS app — pick targets, fill env vars, and write configs safely.