使用说明

项目简介

easyMcp框架是一个简化MCP服务器开发的工具，它预置了MCP协议的基础框架，开发者可以专注于实现具体的业务逻辑和工具，而无需从零开始构建MCP服务器。该框架支持通过简单的配置和工具扩展，快速搭建起符合MCP协议的后端服务，为LLM应用提供上下文数据和功能支持。

主要功能点

快速搭建MCP服务器: 框架提供基础结构，简化服务器搭建流程。
工具 (Tools) 扩展: 通过简单的类继承和配置，即可轻松扩展服务器的功能，为LLM提供丰富的外部工具调用能力。
支持STDIO和SSE: 灵活支持标准输入输出(STDIO)和服务器发送事件(SSE)两种传输协议，适应不同的应用场景和客户端需求。
配置管理: 通过'.env'文件管理服务器配置，方便快捷地进行数据库等连接信息的配置。
示例工具: 提供示例工具代码，帮助开发者快速上手和理解工具的开发方式。

安装步骤

下载依赖: 在项目根目录下运行命令 'uv sync' 下载项目依赖。 (请确保已安装 uv 工具)
配置环境变量: 在 'src/config/.env' 文件中配置你的数据库连接信息等环境变量，例如 MySQL 数据库的 host, port, user, password, database 等。
创建自定义工具: 在 'src/handles' 目录下创建新的 Python 文件，参考 'example.py' 示例，编写你的工具类。
- 继承 'BaseHandler' 类。
- 定义 'name' (工具名称) 和 'description' (工具描述) 属性。
- 实现 'get_tool_description' 方法，定义工具的输入参数和描述信息。
- 实现 'run_tool' 方法，编写工具的具体执行逻辑。
- 在 'src/handles/init.py' 文件中导入并导出你的工具类。
启动服务器: 根据需要选择 STDIO 或 SSE 模式启动服务器。

服务器配置

MCP客户端配置 (JSON 格式)

为了让MCP客户端（如 Cursor, Cline 等）连接到 easyMcp 服务器，需要在客户端中配置服务器信息。以下是 STDIO 和 SSE 两种模式的配置示例，请根据你的启动模式选择其一添加到 MCP 客户端的配置文件中。

1. STDIO 模式配置

{
  "mcpServers": {
      "easyMcp": {
        "isActive": true,
        "name": "easyMcp",
        "command": "uv",  // 启动命令，这里使用 uv
        "args": [
          "--directory",
          "项目src目录的绝对路径",  // 请替换为 easyMcp 项目 src 目录的绝对路径，例如 "G:\\python\\mysql_mcp\\src"
          "run",
          "server.py",
          "--stdio" // 启动参数，指定使用 stdio 模式
        ],
        "env": { // 环境变量配置，如果 .env 文件中已配置，这里可以省略
          "MYSQL_HOST": "数据库HOST",
          "MYSQL_PORT": "数据库端口",
          "MYSQL_USER": "数据库用户名",
          "MYSQL_PASSWORD": "数据库密码",
          "MYSQL_DATABASE": "数据库名",
          "MYSQL_ROLE": "数据库角色"
       }
    }
  }
}

2. SSE 模式配置

{
  "mcpServers": {
    "easyMcp": {
      "name": "easyMcp",
      "description": "",
      "isActive": true,
      "baseUrl": "http://localhost:9000/sse" // SSE 模式的服务器地址
    }
  }
}

启动命令

SSE 模式 (默认)

uv run server.py

STDIO 模式

uv run server.py --stdio

基本使用方法

确保 easyMcp 服务器已成功启动，并根据选择的模式记录服务器地址 (SSE 模式) 或配置启动命令 (STDIO 模式)。
在 MCP 客户端（如 Cursor, Cline）中，根据上述 服务器配置 部分的说明，配置 easyMcp 服务器连接信息。
客户端连接成功后，即可调用 easyMcp 服务器提供的工具，扩展 LLM 的功能。例如，示例工具 'get_Example' 可以通过客户端发送指令进行调用。

关键词