개요

MCP Perfex CRM는 Perfex CRM의 MySQL 데이터베이스에 직접 최적화된 액세스를 제공하는 고성능 Model Context Protocol (MCP) 서버입니다. 이 프로젝트는 코드 품질, 보안 및 유지 보수에 중점을 둔 전통적인 REST APIs에 고성능 대안을 제공합니다.

✅ 현재 상태 - v1.0.0-stable

• **14 기능 모듈 ** 포괄적 인 Perfex CRM 기능을 다루는 186 + 테스트 도구
• **영 경고 ** ESLint 및 TypeScript
• ** GitHub Actions로 CI/CD** 완료 -Robust type system 구현 -Complete API 문서

♨ 특징

• 🔥 Performance: 직접 MySQL 액세스, 10-100x 빠른 REST API
• ️️ 보안: 입력 유효성 검사, 읽기 전용 연결
• Mod **모형 **: 독립 모듈을 가진 Extensible 건축
• Tested: 성장 적용을 가진 Jest 테스트 기구
• ❤️Documented**: 완전한 API 문서 예제
• CI/CD**: 품질문과 자동화된 파이프라인

ܧ 가능한 모듈

핵심 (100% 기능)

• 고객 - 고객 관리 -Estimates - 견적 및 제안

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