AI导哈

CRM协议服务器

一个为CiviCRM提供AI助手直接访问数据和功能的全面模型上下文协议（MCP）服务器。

  • by johncallhub
  • JavaScript
  • 本地部署
  • 5 星标
  • 更新于
在 GitHub 查看 johncallhub/civicrm-mcp-server

使用说明

CiviCRM MCP服务器

CiviCRM的综合模型上下文协议（MCP）服务器，为Claude Desktop等AI助手提供直接访问CiviCRM数据和功能的权限。

🚀 快速安装

选项1：从GitHub安装

npm install -g git+https://github.com/johnjacob/civicrm-mcp-server.git

选项2：从npm安装（如果已发布）

npm install -g civicrm-mcp-server

选项3：克隆和构建

git clone https://github.com/johnjacob/civicrm-mcp-server.git
cd civicrm-mcp-server
npm install
npm run build

📋 先决条件

  • 已安装Node.js 18+
  • 正在运行的CiviCRM实例（本地或可访问）
  • CivilCRM API密钥

⚙️ 配置

1.获取CivilCRM API凭据

  • 以管理员身份登录CiviCRM
  • 首选 联系人 → 查找您的联系人→ API密钥 标签
  • 生成API密钥

2.配置克劳德桌面

添加到您的 claude_desktop_config.json:

{
  "mcpServers": {
    "civicrm": {
      "command": "civicrm-mcp-server",
      "env": {
        "CIVICRM_BASE_URL": "https://your-civicrm-site.com",
        "CIVICRM_API_KEY": "your-api-key-here"
      }
    }
  }
}

全局安装配置路径：

  • macOS： ~/Library/Application Support/Claude/claude_desktop_config.json
  • 窗户： %APPDATA%\Claude\claude_desktop_config.json
  • Linux： ~/.config/Claude/claude_desktop_config.json

🛠️ 可用工具

  • get_contacts -使用自定义字段搜索和检索联系人
  • create_contact -使用自定义字段支持创建新联系人
  • update_contact -更新现有联系人，包括自定义字段
  • list_custom_fields -列出任何实体类型的所有自定义字段
  • 获取活动 -使用自定义字段检索活动
  • 创建活动 -使用自定义字段创建新活动
  • get_贡献 -使用自定义字段查看捐赠/捐款
  • 创建_分配 -使用自定义字段记录新捐款
  • get_events -列出CiviCRM事件
  • 获取会员资格 -查看会员资格
  • 系统信息 -检查CiviCRM状态

✨ 增强的自定义字段支持

  • 自动发现：自动加载和映射所有自定义字段
  • 人性化名称：使用字段标签而不是技术API名称
  • 多实体支持：适用于联系人、活动、贡献自定义字段
  • 智能地图：将可人工调整的字段名称转换为API字段名称
  • 完全集成：所有获取/创建/更新操作中都包含自定义字段

💬 使用示例

基本操作

  • “显示Acme Corporation的所有联系人”
  • “通过电子邮件为Jane Doe创建新联系人jane@example.com"
  • “列出今年所有超过1000美元的捐款”
  • “安排联系人ID为123的会议”

自定义字段示例

  • “列出联系人的所有自定义字段”
  • “显示联系人，包括其成员级别自定义字段”
  • “创建联系人，将自定义字段‘志愿者兴趣’设置为‘环境’”
  • 更新联系人ID 456，并将其“首选通讯方式”设置为“电子邮件”
  • “查找自定义字段“需要跟进”设置为“是”的所有活动”
  • 将带有自定义字段“活动来源”的捐赠记录为“通讯”

🔧 发展

# Clone the repository
git clone https://github.com/johnjacob/civicrm-mcp-server.git
cd civicrm-mcp-server

# Install dependencies
npm install

# Build the project
npm run build

# Run in development mode
npm run dev

📚 文档

看 docs/SETUP.md 有关详细的设置说明。

🤝 贡献

  1. 分叉存储库
  2. 创建要素分支
  3. 进行更改
  4. 彻底测试
  5. 提交拉取请求

📄 许可证

MIT许可证-请参阅 许可证 文件以获取详细信息。

🐛 问题

报告问题：https://github.com/johnjacob/civicrm-mcp-server/issues

⭐ 支持

如果这对你有帮助，请在存储库中加星！

相关 MCP