AgentHubAgentHub

civicrm-mcp

MCP ServerMCP Registry官方收录

io.github.YogiAdhik/civicrm-mcp · v0.1.2

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

概览

civicrm-mcp 是一个MCP Server,收录自 官方 MCP Registry。支持 stdio 传输。本页提供 Cursor、Claude Code 等客户端的安装配置片段。

安装

选择你的平台查看安装方式

{
  "mcpServers": {
    "civicrm-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "civicrm-mcp"
      ],
      "env": {
        "CIVICRM_BASE_URL": "<CIVICRM_BASE_URL>",
        "CIVICRM_API_KEY": "<CIVICRM_API_KEY>"
      }
    }
  }
}

环境变量

CIVICRM_BASE_URL必填

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

CIVICRM_API_KEY必填secret

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.

相关资源

统一 Manifest

{
  "id": "io.github.YogiAdhik/civicrm-mcp",
  "type": "mcp-server",
  "version": "0.1.2",
  "displayName": "civicrm-mcp",
  "description": "Model Context Protocol server for CiviCRM — AuthX-first, schema-introspected, write-gated.",
  "repository": {
    "url": "https://github.com/YogiAdhik/civicrm-mcp",
    "source": "github"
  },
  "distribution": {
    "packages": [
      {
        "registryType": "npm",
        "identifier": "civicrm-mcp",
        "version": "0.1.2",
        "transport": "stdio",
        "environmentVariables": [
          {
            "name": "CIVICRM_BASE_URL",
            "description": "Base URL of the CiviCRM install, e.g. https://crm.example.org. No trailing slash.",
            "isRequired": true
          },
          {
            "name": "CIVICRM_API_KEY",
            "description": "API key of the contact the server authenticates as. Keep it on a dedicated 'MCP Bot' contact with minimum permissions.",
            "isRequired": true,
            "isSecret": true
          },
          {
            "name": "CIVICRM_CMS",
            "description": "CMS host: drupal, wordpress, standalone, or backdrop."
          },
          {
            "name": "CIVICRM_SITE_KEY",
            "description": "Optional — only needed if the site enables the AuthX site-key guard.",
            "isSecret": true
          },
          {
            "name": "CIVICRM_AUTH_MODE",
            "description": "authx (default, recommended) or legacy for pre-5.36 installs."
          },
          {
            "name": "CIVICRM_ALLOW_WRITES",
            "description": "Set to 'true' to enable create / update / save / submit actions. Off by default."
          },
          {
            "name": "CIVICRM_ALLOW_DELETES",
            "description": "Set to 'true' to enable delete / replace actions. Off by default."
          }
        ]
      }
    ],
    "remotes": []
  },
  "dependencies": [],
  "installTargets": [
    "claude-code",
    "claude-desktop",
    "cursor",
    "vscode"
  ],
  "keywords": [],
  "provenance": {
    "origin": "official-mcp-registry",
    "originalId": "io.github.YogiAdhik/civicrm-mcp",
    "originalUrl": "https://registry.modelcontextprotocol.io/v0.1/servers/io.github.YogiAdhik%2Fcivicrm-mcp/versions/latest",
    "isOfficial": true,
    "status": "active"
  }
}
civicrm-mcp — MCP Server 安装与配置 · AgentHub