MCP Framework

🚀 MCP Framework Development Guide

MCP (Model Context Protocol) is an open-source framework for developing and deploying intelligent applications. It offers unified protocols, tools, and services to help developers quickly build efficient applications.

✨ Features

• Unified Protocol: Provides standardized interfaces for easy communication between different components.
• Modular Design: Supports plugin extensions and can be flexibly customized according to requirements.
• High Performance: Based on an asynchronous framework, it can handle large-scale requests with ease.
• Built-in Tools: Integrates common functions such as document processing and data analysis.

Project Structure

MCP Framework Directory Structure
├── mcp/types.py          # Define content types and interfaces
├── tools/                # Tool implementations
│   ├── base_tool.py      # Definition of the base tool class
│   └── specific_tool.py  # Implementation of specific tools
└── server.py             # Implementation of the MCP server

🚀 Quick Start

Install Dependencies

pip install mcp[all]  # Install all dependencies
# Or install on-demand:
pip install pyMuPDF python-docx pandas openpyxl httpx anyio click

Start the Service

uv run mcp.server --transport sse --port 8000

Access the SSE endpoint: http://localhost:8000/sse

📚 Documentation

MCP Protocol

MCP defines a set of standardized protocols for interaction between different components. The core contents include:

• Content Types:

  • Text content (types.TextContent)
  • Image content (types.ImageContent)
  • Embedded resources (types.EmbeddedResource)

• Communication Protocol:

  • Uses Server-Sent Events (SSE) for real-time communication
  • Supports the HTTP/HTTPS protocol stack

Tool Development Guide

Develop a New Tool

1. Create a new Python file in the tools directory, for example, your_tool.py.
2. Import the necessary dependencies and base classes:

   import mcp.types as types
   from . import BaseTool, ToolRegistry
   

3. Create a tool class that inherits from BaseTool:

   @ToolRegistry.register
   class YourTool(BaseTool):
       """Your tool description"""
       name = "your_tool_name"  # Unique identifier for the tool
       description = "Your tool description"  # Description of the tool, which will be displayed to users
       input_schema = {
           "type": "object",
           "required": ["param1"],  # Required parameters
           "properties": {
               "param1": {
                   "type": "string",
                   "description": "Description of parameter 1",
               },
               "param2": {
                   "type": "integer",
                   "description": "Description of parameter 2 (optional)",
               }
           },
       }
   
   async def execute(self, arguments: dict) -> list[types.TextContent | types.ImageContent | types.EmbeddedResource]:
       """Execute the tool logic"""
       # Parameter validation
       if "param1" not in arguments:
           return [types.TextContent(
               type="text",
               text="Error: Missing required parameter"
           )]
       
       # Processing logic
       result = self._process_arguments(arguments)
       
       return [types.TextContent(
           type="text",
           text=str(result)
       )]
   

Project Structure

MCP Framework Directory Structure
├── mcp/
│   ├── types.py          # Define content types and interfaces
│   └── server.py         # Implementation of the MCP server
└── tools/
    ├── base_tool.py      # Definition of the base tool class
    └── specific_tool.py  # Implementation of specific tools

Deployment Guide

Environment Requirements

• Operating System: Linux, macOS, Windows (Linux is recommended)
• Python Version: 3.8+

Install Dependencies

pip install mcp[all]  # Install all dependencies
# Or install on-demand:
pip install pyMuPDF python-docx pandas openpyxl httpx anyio click

Start the Service

uv run mcp.server --transport sse --port 8000

Access the SSE endpoint: http://localhost:8000/sse

Configuration Guide

Basic Configuration

Edit the config.py file:

from mcp.config import Config

Config.load_defaults()
# Or customize the configuration:
Config.set('debug_mode', True)

Advanced Configuration

Configure through command-line parameters:

uv run mcp.server --config your_config.yaml --port 8000

Dependency Management

The MCP framework depends on the following libraries:

• PyMuPDF: For PDF document processing
• python-docx: For Word document processing
• pandas: For data analysis
• openpyxl: For Excel file operations
• httpx: For HTTP requests
• anyio: For asynchronous programming
• click: For command-line tools

Contribution Guide

Submit Code

1. Fork the project repository.
2. Create a new branch (git checkout -b feature/your-feature).
3. Commit your changes (git add .; git commit -m "your commit message").
4. Push to the remote repository.
5. Create a Pull Request.

Development Specifications

• Follow the PEP8 code style guide.
• Provide detailed documentation.
• Include unit test cases.
• Ensure that the code passes CI/CD tests.

📄 License

The MCP framework is licensed under the MIT License. See the LICENSE file for specific terms.

Contact Information

• GitHub: mcp-framework
• Mailing List: dev@mcpframework.org
• Chinese Community: mcp-discuss-cn