MCP server
Civicrm MCP
Model Context Protocol server for CiviCRM — AuthX-first, schema-introspected, write-gated.
Runs locallyStatus and history
- Pricing
- Open source
- Runs
- Locally
- Version
- 0.1.2
- Listing updated
- 5 days ago
About Civicrm MCP
Civicrm MCP is an open-source MCP server. It runs locally on your machine and is started by your AI client.
Install
Run in a terminal
claude mcp add civicrm-mcp --env CIVICRM_BASE_URL='<CIVICRM_BASE_URL>' --env CIVICRM_API_KEY='<CIVICRM_API_KEY>' --env CIVICRM_SITE_KEY='<CIVICRM_SITE_KEY>' -- npx -y civicrm-mcpAdd to claude_desktop_config.json
{
"mcpServers": {
"civicrm-mcp": {
"command": "npx",
"args": [
"-y",
"civicrm-mcp"
],
"env": {
"CIVICRM_BASE_URL": "<CIVICRM_BASE_URL>",
"CIVICRM_API_KEY": "<CIVICRM_API_KEY>",
"CIVICRM_SITE_KEY": "<CIVICRM_SITE_KEY>"
}
}
}
}Add to ~/.cursor/mcp.json
{
"mcpServers": {
"civicrm-mcp": {
"command": "npx",
"args": [
"-y",
"civicrm-mcp"
],
"env": {
"CIVICRM_BASE_URL": "<CIVICRM_BASE_URL>",
"CIVICRM_API_KEY": "<CIVICRM_API_KEY>",
"CIVICRM_SITE_KEY": "<CIVICRM_SITE_KEY>"
}
}
}
}Add to .vscode/mcp.json
{
"servers": {
"civicrm-mcp": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"civicrm-mcp"
],
"env": {
"CIVICRM_BASE_URL": "<CIVICRM_BASE_URL>",
"CIVICRM_API_KEY": "<CIVICRM_API_KEY>",
"CIVICRM_SITE_KEY": "<CIVICRM_SITE_KEY>"
}
}
}
}Add to ~/.codeium/windsurf/mcp_config.json
{
"mcpServers": {
"civicrm-mcp": {
"command": "npx",
"args": [
"-y",
"civicrm-mcp"
],
"env": {
"CIVICRM_BASE_URL": "<CIVICRM_BASE_URL>",
"CIVICRM_API_KEY": "<CIVICRM_API_KEY>",
"CIVICRM_SITE_KEY": "<CIVICRM_SITE_KEY>"
}
}
}
}Add to your client's MCP settings (most use this shape)
{
"mcpServers": {
"civicrm-mcp": {
"command": "npx",
"args": [
"-y",
"civicrm-mcp"
],
"env": {
"CIVICRM_BASE_URL": "<CIVICRM_BASE_URL>",
"CIVICRM_API_KEY": "<CIVICRM_API_KEY>",
"CIVICRM_SITE_KEY": "<CIVICRM_SITE_KEY>"
}
}
}
}Configuration
CIVICRM_BASE_URLBase URL of the CiviCRM install, e.g. https://crm.example.org. No trailing slash.RequiredCIVICRM_API_KEYAPI key of the contact the server authenticates as. Keep it on a dedicated 'MCP Bot' contact with minimum permissions.RequiredCIVICRM_CMSCMS host: drupal, wordpress, standalone, or backdrop.CIVICRM_SITE_KEYOptional — only needed if the site enables the AuthX site-key guard.CIVICRM_AUTH_MODEauthx (default, recommended) or legacy for pre-5.36 installs.CIVICRM_ALLOW_WRITESSet to 'true' to enable create / update / save / submit actions. Off by default.CIVICRM_ALLOW_DELETESSet to 'true' to enable delete / replace actions. Off by default.
Pricing
Open source
Civicrm MCP FAQ
Is Civicrm MCP free?
Yes. Civicrm MCP is open source, so you can use and self-host it for free.
How do I add Civicrm MCP to Claude Code?
Run this command in your terminal: claude mcp add civicrm-mcp --env CIVICRM_BASE_URL='<CIVICRM_BASE_URL>' --env CIVICRM_API_KEY='<CIVICRM_API_KEY>' --env CIVICRM_SITE_KEY='<CIVICRM_SITE_KEY>' -- npx -y civicrm-mcp