Patronus MCP Server

🚀 Model Context Protocol (MCP) Server Implementation

This is a server-side implementation of the Model Context Protocol (MCP) using Python. MCP is a protocol designed for interacting with AI models and retrieving context information. The project offers an extensible framework that allows developers to add new features and tools through plugins.

✨ Features

• Built-in Tool Support: Provides multiple predefined tools, such as network requests, file operations, and data analysis.
• Dynamic Plugin Loading: Supports dynamic feature expansion through plugins, facilitating maintenance and upgrades.
• Asynchronous Task Processing: Adopts an asynchronous programming model to efficiently handle high-concurrency tasks.
• Logging and Monitoring: Integrates comprehensive logging and performance monitoring functions for easy debugging and optimization.

🚀 Quick Start

📦 Installation

pip install -r requirements.txt

Initial Configuration

Create a config.yaml file:

logging:
  level: INFO
  file: logs/app.log
  rotate: true
services:
  plugins:
    - plugin1
    - plugin2

Start the Service

python -m src.patronus_mcp.server --config config.yaml

💻 Usage Examples

Basic Usage

Network Request Tool

from patronus import tool

@tool()
def fetch_url(url: str) -> dict:
    """Fetch data from the specified URL"""
    response = requests.get(url)
    return json.loads(response.text)

File Operation Tool

from typing import List, Optional
from patronus import tool

@tool()
def read_file(path: str, encoding: Optional[str] = 'utf-8') -> List[str]:
    """Read file content and return a list of lines"""
    with open(path, 'r', encoding=encoding) as f:
        return [line.strip() for line in f.readlines()]

📚 Documentation

Project Structure

patronus-mcp-server/
├── src/
│   └── patronus_mcp/
│       ├── __init__.py
│       └── server.py
├── tests/
│   └── test_server.py
    └── test_live.py
├── pyproject.toml
└── README.md

Adding New Features

1. Define a new request model in server.py:

class NewFeatureRequest(BaseModel):
    field1: str
    field2: Optional[int] = None

2. Implement the new feature using the @mcp.tool() decorator:

@mcp.tool()
def new_feature(request: Request[NewFeatureRequest]) -> Any:
    """Implement new business logic"""
    pass

3. Add corresponding test cases in the test file:

def test_new_feature():
    request = Request(...)
    response = new_feature(request)
    assert isinstance(response, ...)

Running Tests

Unit Tests

pytest tests/test_server.py -v

Integration Tests

pytest tests/test_live.py -v

📄 License

This project is licensed under the MIT License. Here is the full license text:

Copyright (c) [Year], [Author's Name]
You may use, copy, modify, and distribute this software, subject to the following conditions:

1. Retain the copyright notice and this license notice in any redistribution or derivative work.
2. Do not make any false claims or representations about the software.
   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.

🤝 Contribution Guidelines

1. Fork the project repository.
2. Create a new feature branch: git checkout -b feature/new-feature
3. Commit your code changes: git add . && git commit -m 'Add new feature'
4. Push to the remote repository: git push origin feature/new-feature
5. Submit a Pull Request to the main branch.

📞 Contact Information

• Project Email: contact@example.com
• Developer Community: Join the QQ Group
• Official Documentation: Visit the Official Documentation Website

⚠️ Important Note

This translation maintains the original structure and information of the text, only converting the words to English.