descomplicar-marketing-e-tecnologia/mcp-perfex-crm

本页由 AI 翻译，技术细节请以原文为准。查看原文

34 stars 18 forks 质量 71 趋势 12MIT

descomplicar-marketing-e-tecnologia/mcp-perfex-crm 是从 https://github.com/descomplicar-marketing-e-tecnologia/mcp-perfex-crm. 导入的 MCP 服务器候选

概览

descomplicar-marketing-e-tecnologia/mcp-perfex-crm 是从 https://github.com/descomplicar-marketing-e-tecnologia/mcp-perfex-crm. 导入的 MCP 服务器候选

概述（AI 翻译）

🎯 概述

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

✅ 当前状态 - v1.0.0-稳定

14个功能模块，配备186+测试工具，涵盖全面的Perfex CRM功能
ESLint 和 TypeScript 中的零警告
完整的CI/CD与GitHub Actions合作
稳健类型系统 实现
完整的API文档

🚀 特色

🔥 性能：直接MySQL访问，比REST API快10-100倍
🛡️ 安全性：预备语句、输入验证、只读连接
📊 模块化：具有独立模块的可扩展架构
🧪 Tested：正在扩大覆盖范围的 Jest 测试框架
📝 文档化：完整的API文档及示例
🔄 CI/CD：带有质量门的自动化流水线

📦 可用模块

核心（100%功能正常）

客户 - 全面的客户管理
估算 - 估算和提案

本页由 AI 翻译，技术细节请以原文为准。

README

以下为原文 README 节选，完整内容请查看原文。

MCP Perfex CRM - High-Performance MCP Server for Perfex CRM

🎯 Overview

MCP Perfex CRM is a high-performance Model Context Protocol (MCP) server that provides direct and optimized access to Perfex CRM’s MySQL database. This project offers a high-performance alternative to traditional REST APIs, with focus on code quality, security, and maintainability.

✅ Current Status - v1.0.0-stable

14 functional modules with 186+ tested tools covering comprehensive Perfex CRM functionality
Zero warnings in ESLint and TypeScript
Complete CI/CD with GitHub Actions
Robust type system implemented
Complete API documentation

🚀 Features

🔥 Performance: Direct MySQL access, 10-100x faster than REST API
🛡️ Security: Prepared statements, input validation, read-only connections
📊 Modular: Extensible architecture with independent modules
🧪 Tested: Jest testing framework with growing coverage
📝 Documented: Complete API documentation with examples
🔄 CI/CD: Automated pipeline with quality gates

📦 Available Modules

Core (100% Functional)

Customers - Complete customer management
Estimates - Estimates and proposals
Invoices - Complete invoice management with payments and statistics (8 tools)
Leads - Lead management, conversion, and lifecycle tracking (9 tools)
Projects - Project management
Tasks - Task control
Contracts - Contract management
Payments - Payment processing
Expenses - Expense control
Tickets - Complete support system with delete/export tools

Reporting

Financial Reporting - Advanced financial reports
Resource Management - Resource management
Timesheets - Time tracking

Utilities

Subscriptions - Subscription management
Credit Notes - Credit notes

🛠️ Installation

Option 1: NPM Installation (Recommended)

npm install -g mcp-perfex-crm

Option 2: Local Installation

# Clone repository
git clone https://github.com/YOUR_USERNAME/mcp-perfex-crm
cd mcp-perfex-crm

# Install dependencies
npm install

# Configure environment
cp .env.example .env
# Edit .env with your MySQL settings

# Compile project
npm run build

# Run tests
npm test

⚙️ Configuration

1. Database Configuration

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

# Log optimization for production

在 GitHub 查看完整 README

安装

This server does not publish a one-line install command.

Open the repository installation guide 新手？先看 mcpskill.org 教程 →

配置

{
  "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"
      }
    }
  }
}