STARWARCLOUD STARWAR.AI
返回市场
麦普绩效CRM

麦普绩效CRM

作者：Descomplicar-Marketing-e-Tecnologia6 星标更新：2025-10-06
安装使用来源：spider==github.com

项目介绍

MCP Perfex CRM - 高性能的MCP服务器用于Perfex CRM

npm版本 TypeScript 许可证 模型上下文协议 N8N兼容

🎯 概述

MCP Perfex CRM 是一个高性能的模型上下文协议（MCP）服务器，提供对Perfex CRM的MySQL数据库的直接和优化访问。该项目提供了比传统REST API更高的性能，同时注重代码质量、安全性和可维护性。

✅ 当前状态 - v1.0.0-stable

  • 14个功能模块，包含186多个经过测试的工具，覆盖全面的Perfex CRM功能
  • 零警告在ESLint和TypeScript中
  • 完整的CI/CD使用GitHub Actions
  • 强大的类型系统已实现
  • 完整的API文档

🚀 特点

  • 🔥 性能：直接访问MySQL，比REST API快10-100倍
  • 🛡️ 安全性：预编译语句，输入验证，只读连接
  • 📊 模块化：具有独立模块的可扩展架构
  • 🧪 测试：使用Jest测试框架，覆盖率不断增加
  • 📝 文档：带有示例的完整API文档
  • 🔄 CI/CD：带有质量门的自动化流水线

📦 可用模块

核心（100%功能性）

  • 客户 - 完整的客户管理
  • 报价 - 报价和提案
  • 发票 - 包含支付和统计的完整发票管理（8个工具）
  • 潜在客户 - 潜在客户管理，转换和生命周期跟踪（9个工具）
  • 项目 - 项目管理
  • 任务 - 任务控制
  • 合同 - 合同管理
  • 支付 - 支付处理
  • 费用 - 费用控制
  • 票证 - 带有删除/导出工具的完整支持系统

报告

  • 财务报告 - 高级财务报告
  • 资源管理 - 资源管理
  • 工时表 - 时间跟踪

实用工具

  • 订阅 - 订阅管理
  • 信用备忘录 - 信用备忘录

🛠️ 安装

选项1：NPM安装（推荐）

npm install -g mcp-perfex-crm

选项2：本地安装

# 克隆仓库
git clone https://github.com/YOUR_USERNAME/mcp-perfex-crm
cd mcp-perfex-crm

# 安装依赖
npm install

# 配置环境
cp .env.example .env
# 使用您的MySQL设置编辑.env

# 编译项目
npm run build

# 运行测试
npm test

⚙️ 配置

1. 数据库配置

# .env
MYSQL_HOST=localhost
MYSQL_PORT=3306
MYSQL_USER=perfex_readonly
MYSQL_PASSWORD=your_password
MYSQL_DATABASE=perfex_crm

# 生产日志优化
LOG_LEVEL=error
NODE_ENV=production
ENABLE_AUDIT_LOG=false

2. N8N集成

MCP Perfex CRM 完全兼容N8N进行工作流自动化：

# 作为N8N工具安装
npm install -g mcp-perfex-crm

# 或在N8N Docker中使用
FROM n8nio/n8n:latest
RUN npm install -g mcp-perfex-crm

N8N工作流示例：

{
  "nodes": [
    {
      "parameters": {
        "command": "mcp-perfex-crm",
        "options": {
          "env": {
            "MYSQL_HOST": "your-db-host",
            "MYSQL_USER": "readonly_user",
            "MYSQL_PASSWORD": "secure_password",
            "MYSQL_DATABASE": "perfex_crm"
          }
        }
      },
      "type": "@n8n/n8n-nodes-langchain.toolWorkflow",
      "position": [250, 300],
      "id": "perfex-crm-tool"
    }
  ]
}

3. Claude Desktop集成

{
  "mcpServers": {
    "mcp-perfex-crm": {
      "command": "mcp-perfex-crm",
      "env": {
        "MYSQL_HOST": "localhost",
        "MYSQL_PORT": "3306",
        "MYSQL_USER": "perfex_readonly",
        "MYSQL_PASSWORD": "your_password",
        "MYSQL_DATABASE": "perfex_crm"
      }
    }
  }
}

对于本地安装：

{
  "mcpServers": {
    "mcp-perfex-crm": {
      "command": "node",
      "args": ["/path/to/mcp-perfex-crm/dist/index.js"],
      "env": {
        "MYSQL_HOST": "localhost",
        "MYSQL_PORT": "3306",
        "MYSQL_USER": "perfex_readonly",
        "MYSQL_PASSWORD": "your_password",
        "MYSQL_DATABASE": "perfex_crm"
      }
    }
  }
}

📖 使用

示例：列出客户

// 通过MCP
const result = await use_mcp_tool({
  server_name: "mcp-perfex-crm",
  tool_name: "get_customers",
  arguments: {
    limit: 10,
    active: true
  }
});

示例：创建项目

const result = await use_mcp_tool({
  server_name: "mcp-perfex-crm",
  tool_name: "create_project",
  arguments: {
    name: "新网站",
    client_id: 123,
    start_date: "2025-02-01",
    billing_type: "固定费率",
    project_cost: 5000
  }
});

🧪 开发

# 开发模式带热重载
npm run dev

# 运行linter
npm run lint

# 格式化代码
npm run format

# 运行带有覆盖率的测试
npm run test:coverage

# 生产构建
npm run build

📊 代码质量

  • ✅ TypeScript：强大的类型系统
  • ✅ ESLint：零警告，严格的配置
  • ✅ Prettier：一致的格式化
  • ✅ Jest：配置好的测试框架
  • ✅ GitHub Actions：自动化的CI/CD
  • ✅ 优化的日志记录：生产配置，最小化上下文影响

🔒 安全

  • 所有查询都使用预编译语句
  • 对所有工具进行输入验证
  • 默认只读连接
  • 敏感操作的审计日志
  • 日志中的敏感数据掩码

🤝 贡献

欢迎贡献！请：

  1. 分叉项目
  2. 创建功能分支（git checkout -b feature/AmazingFeature）
  3. 提交更改（git commit -m '添加一些AmazingFeature'）
  4. 推送到分支（git push origin feature/AmazingFeature）
  5. 打开拉取请求

代码标准

  • 遵循配置好的TypeScript/ESLint风格
  • 新功能添加测试
  • 保持文档更新
  • 零警告是强制性的

📈 发展路线图

v1.0.1（2025年2月）

  • 增强错误处理
  • 性能指标仪表板
  • 自动文档生成
  • 扩展测试覆盖率

v1.1.0（2025年第一季度）

  • 测试覆盖率>80%
  • 完整的TypeScript严格模式
  • 网络钩子支持
  • 智能缓存

v1.2.0（2025年第二季度）

  • 分析仪表板
  • 批量操作
  • GraphQL网关
  • 增强多租户支持

📝 文档

📄 许可证

本项目采用MIT许可证 - 详情见LICENSE文件。

👨‍💻 作者

Emanuel Almeida

🙏 致谢

  • Anthropic团队为模型上下文协议
  • Perfex CRM社区
  • 所有贡献者

📊 性能基准

操作REST APIMCP直接改进
获取客户（100）2.3秒0.23秒快10倍
创建项目1.8秒0.18秒快10倍
复杂查询5.2秒0.52秒快10倍

🏗️ 架构

mcp-perfex-crm/
├── src/
│   ├── modules/          # 业务逻辑模块
│   ├── tools/            # MCP工具实现
│   ├── types/            # TypeScript定义
│   ├── utils/            # 工具函数
│   └── connections/      # 数据库连接
├── tests/                # 测试套件
├── docs/                 # 文档
└── examples/             # 使用示例

⭐ 如果这个项目帮助了您，请考虑给它一个星！

🚀 准备加速您的Perfex CRM集成？现在开始吧！