Easymcp

🚀 easyMcp

easyMcp仅需两步即可帮助开发者快速构建一个可扩展的mcp服务器框架，支持标准输入输出和SSE两种启动模式，为开发者提供便捷的开发体验。

🚀 快速开始

✨ 主要特性

• 仅需两步即可快速构建可扩展的mcp服务器框架。
• 支持标准输入输出和SSE两种启动模式。

📦 安装指南

文档未提及具体安装步骤，但使用前需确保已正确安装所有必要的依赖项。

💻 使用示例

基础用法

1. 第一步[可选] 定义所需配置

在src/config/.env文件中定义项目所需的配置，例如数据库配置：

# MySQL 数据库配置
MYSQL_HOST=192.168.3.229
MYSQL_PORT=3306
MYSQL_USER=root
MYSQL_PASSWORD=root
MYSQL_DATABASE=a_llm
MYSQL_ROLE=admin

2. 第二步 创建自己的工具

将你自己定义的工具类添加到src/handles目录中，参考示例.py中的样本：

• 继承自BaseHandler类。
• 定义name属性，表示工具的名字。
• 定义description属性，表示工具的描述。
• 实现get_tool_description方法，告诉mcp客户端你的工具的作用。
• 实现run_tool方法，这是由mcp客户端调用来执行你工具逻辑的方法。
• 在__init__.py中引用新的工具。

示例.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": "这是必须输入的文本内容"
                    }
                },
                "required": ["text"]
            }
        )

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

            try:
                if "text" not in arguments:
                    raise ValueError("缺少文本内容")

                text = arguments["text"]

                # 引用配置信息
                config = get_config()

                ## todo something

                result = "xxxxxxx"

                # 将所有结果用逗号连接
                return [TextContent(type="text", text=','.join(result))]

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

__init__.py

from .example import Example


__all__ = [
    "Example",
]

3. 启动

目前，此框架支持两种启动模式：标准输入输出和SSE。

1. SSE 模式

• 使用uv启动服务 在你的mcp客户端工具中添加以下内容，例如cursor、cline等。 mcp json如下所示：

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

启动命令

# 下载依赖
uv sync

# 启动
uv start

2. STDIO 模式

• 在终端中运行以下命令来启动服务：

python main.py

注意事项

⚠️ 重要提示

• 确保你已经正确安装了所有必要的依赖项。
• 在使用SSE模式时，确保你的网络连接稳定。
• 如果遇到任何问题，请检查日志文件以获取更多信息。