easyMcp

Just two steps to help developers quickly build an extensible mcp server framework that supports both stdio and SSE startup modes.

User Manual

1. Step One [Optional] Define Required Configuration

Define your project's required configuration in src/config/.env, for example, database configuration:

 # MySQL Database Configuration
MYSQL_HOST=192.168.3.229
MYSQL_PORT=3306
MYSQL_USER=root
MYSQL_PASSWORD=root
MYSQL_DATABASE=a_llm
MYSQL_ROLE=admin

2. Step Two Create Your Own Tools

Add your own tool classes in the src/handles directory, refer to the example.py sample

Inherit from BaseHandler
Define the name property, which is the tool's name
Define the description property, which is the tool's description
Implement the get_tool_description method, which tells the mcp client what your tool does
Implement the run_tool method, which is called by the mcp client to execute your tool's logic
Reference the new tool in init.py

example.py

from typing import Dict, Any, Sequence

from mcp import Tool
from mcp.types import TextContent
from .base import BaseHandler
from config import get_config


class Example(BaseHandler):
    name = "get_Example"
    description = (
        "this is Example xxxx"
    )

    def get_tool_description(self) -> Tool:
        return Tool(
            name=self.name,
            description=self.description,
            inputSchema={
                "type": "object",
                "properties": {
                    "text": {
                        "type": "string",
                        "description": "This is the text that must be entered for the example"
                    }
                },
                "required": ["text"]
            }
        )

    async def run_tool(self, arguments: Dict[str, Any]) -> Sequence[TextContent]:

            try:
                if "text" not in arguments:
                    raise ValueError("Missing text content")

                text = arguments["text"]

                # Reference configuration information
                config = get_config()

                ## todo something

                result = "xxxxxxx"

                # Join all results with commas
                return [TextContent(type="text", text=','.join(result))]

            except Exception as e:
                return [TextContent(type="text", text=f"error: {str(e)}")]

init.py

from .example import Example


__all__ = [
    "Example",
]

3. Startup

Currently, this framework supports two startup modes: stdio and SSE.

1. SSE Mode

Start the service using uv

Add the following content to your mcp client tool, such as cursor, cline, etc.

mcp json as follows

{
  "mcpServers": {
    "easyMcp": {
      "name": "easyMcp",
      "description": "",
      "isActive": true,
      "baseUrl": "http://localhost:9000/sse"
    }
  }
}

Startup command

# Download dependencies
uv sync

# Start
uv run server.py

2. STDIO Mode

Add the following content to your mcp client tool, such as cursor, cline, etc.

mcp json as follows

{
  "mcpServers": {
      "easyMcp": {
        "isActive": true,
        "name": "easyMcp",
        "command": "uv",
        "args": [
          "--directory",
          "G:\\python\\mysql_mcp\\src",  # Replace this with your project path
          "run",
          "server.py",
          "--stdio"
        ],
        "env": {
          "MYSQL_HOST": "192.168.xxx.xxx",
          "MYSQL_PORT": "3306",
          "MYSQL_USER": "root",
          "MYSQL_PASSWORD": "root",
          "MYSQL_DATABASE": "a_llm",
          "MYSQL_ROLE": "admin"
       }
    }
  }
}    

## Effect diagram
![image](https://github.com/user-attachments/assets/72854681-16ad-4dc8-a095-5e6e63e07deb)

Categories

Current Category: easy-mcp

easyMcp