MCP Server
MCP
io.github.YogiAdhik/civicrm-mcp
Model Context Protocol server for CiviCRM — AuthX-first, schema-introspected, write-gated.
Install
npx -y [email protected]
Configuration Example
{
"remotes": [],
"packages": [
{
"registryType": "npm",
"identifier": "civicrm-mcp",
"version": "0.1.2",
"transport": {
"type": "stdio"
},
"environmentVariables": [
{
"description": "Base URL of the CiviCRM install, e.g. https://crm.example.org. No trailing slash.",
"isRequired": true,
"format": "string",
"name": "CIVICRM_BASE_URL"
},
{
"description": "API key of the contact the server authenticates as. Keep it on a dedicated 'MCP Bot' contact with minimum permissions.",
"isRequired": true,
"format": "string",
"isSecret": true,
"name": "CIVICRM_API_KEY"
},
{
"description": "CMS host: drupal, wordpress, standalone, or backdrop.",
"format": "string",
"default": "drupal",
"name": "CIVICRM_CMS"
},
{
"description": "Optional — only needed if the site enables the AuthX site-key guard.",
"format": "string",
"isSecret": true,
"name": "CIVICRM_SITE_KEY"
},
{
"description": "authx (default, recommended) or legacy for pre-5.36 installs.",
"format": "string",
"default": "authx",
"name": "CIVICRM_AUTH_MODE"
},
{
"description": "Set to 'true' to enable create / update / save / submit actions. Off by default.",
"format": "string",
"default": "false",
"name": "CIVICRM_ALLOW_WRITES"
},
{
"description": "Set to 'true' to enable delete / replace actions. Off by default.",
"format": "string",
"default": "false",
"name": "CIVICRM_ALLOW_DELETES"
}
]
}
]
}
mcp
model-context-protocol
npm
By
Comments
Sign in to leave a comment