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模式時，確保你的網絡連接穩定。
• 如果遇到任何問題，請檢查日誌文件以獲取更多信息。