MCP Engine

🚀 MCP Engine Project Documentation

The MCP Engine (MCPEngine) is a toolchain for building and managing enterprise-level message processing systems. It offers a rich set of functional modules, including resource management, task scheduling, logging, and monitoring, aiming to simplify the enterprise's message processing workflow.

🚀 Quick Start

Install the MCP Engine

Install the MCP Engine using pip:

pip install mcp-engine

Create Your First Service

Here is a simple example of an MCP service:

from mcpengine import MCPEngine

mcp = MCPEngine("First Service")


@mcp.tool()
def greet(name: str):
    return f"Hello, {name}!"


if __name__ == "__main__":
    mcp.start()

Run the Service

Run the above script:

python first_service.py

✨ Features

Resource Management

• Data Storage: Supports the storage and retrieval of multiple data sources, including relational databases (e.g., MySQL, PostgreSQL) and NoSQL databases (e.g., MongoDB).
• File Management: Provides the ability to operate on the file system, including uploading, downloading, deleting, and directory management.

Task Scheduling

• Job Management: Allows the definition and execution of periodic tasks, supporting multiple triggers (e.g., time-based, event-based).
• Dependency Management: Can handle the dependencies between tasks to ensure they are executed in the correct order.

Logging and Monitoring

• Log Collection: Integrates multiple logging services (e.g., ELK stack) for centralized log management and analysis.
• Performance Monitoring: Offers real-time monitoring to track system resource usage and task execution status.

💻 Usage Examples

Simple Calculator Service

Here is a simple example of an MCP Engine service for basic arithmetic operations:

from mcpengine import MCPEngine

mcp = MCPEngine("Simple Calculator")


@mcp.tool()
def add(a: int, b: int):
    return a + b


@mcp.tool()
def subtract(a: int, b: int):
    return a - b


@mcp.tool()
def multiply(a: int, b: int):
    return a * b


@mcp.tool()
def divide(a: int, b: int):
    if b == 0:
        raise ValueError("Cannot divide by zero")
    return a / b

File Upload Service

Here is an example of a file upload service:

import os
from mcpengine import MCPEngine

mcp = MCPEngine("File Upload Service")


@mcp.tool()
def upload_file(path: str, content: bytes):
    try:
        with open(path, 'wb') as f:
            f.write(content)
        return f"File uploaded to path: {path}"
    except Exception as e:
        raise ValueError(f"File upload failed: {str(e)}")


@mcp.resource("file://{path}")
def get_file_content(path: str):
    if not os.path.exists(path):
        raise FileNotFoundError(f"File {path} does not exist")
    with open(path, 'rb') as f:
        return f.read()

📚 Documentation

Architecture Design

Main Components

1. Core Engine: Responsible for handling the core logic of the MCP Engine, including task scheduling and resource management.
2. Plugin System: Allows users to extend the functionality of the MCP Engine, supporting the integration of multiple data sources and protocols.
3. Monitoring and Logging Module: Provides real-time monitoring and logging functions for easy diagnosis and maintenance.

Component Interaction Process

1. Task Submission: Users submit tasks through the API provided by the MCP Engine.
2. Dependency Check: The core engine checks the dependencies between tasks.
3. Resource Allocation: Allocates computing resources according to task requirements.
4. Task Execution: Tasks are executed sequentially or in parallel.
5. Result Feedback: After task completion, the results are returned to the user.

Project Architecture Diagram

Contribution Guidelines

How to Contribute Code

1. Clone the Repository: Use Git to clone the source code repository of the MCP Engine.
2. Create a Feature Branch: Create a separate branch for each new feature or fix.
3. Submit Code: When submitting code, include detailed commit messages explaining the changes and reasons.

How to Report Issues

Please submit issues through the project's GitHub repository. Ensure clear descriptions and attach necessary logs and error information.

Community and Support

• GitHub Repository: MCP Engine
• Developer Mailing List: mcengine-dev@lists.sourceforge.net
• Chinese Community Forum: MCP Engine Discussion Area

📄 License

The MCP Engine is licensed under the MIT License, allowing users to freely use, modify, and distribute the code.