Ezmcp

🚀 ezmcp

ezmcp 是一個易於使用的、專為SSE設計的MCP服務器框架，它能讓創建兼容MCP的服務器變得輕鬆簡單，採用了FastAPI式的語法，為開發者帶來便捷的開發體驗。

🚀 快速開始

from ezmcp import ezmcp, TextContent

# 創建一個ezmcp應用程序
app = ezmcp("my-app")

# 定義一個工具
@app.tool(description="Echo a message back to the user")
async def echo(message: str):
    """回顯用戶的消息."""
    return [TextContent(type="text", text=f"Echo: {message}")]

# 運行應用程序
if __name__ == "__main__":
    app.run(host="0.0.0.0", port=8000)

一旦服務器運行，你可以：

• 訪問交互式文檔頁面 http://localhost:8000/docs
• 連接到SSE端點 http://localhost:8000/sse

✨ 主要特性

• FastAPI風格的裝飾器API：用於定義MCP工具，讓工具定義更加簡潔明瞭。
• 自動參數驗證和類型轉換：減少開發者手動處理參數的工作量，提高開發效率。
• 自動生成工具模式：從函數簽名自動生成工具模式，方便快捷。
• 內置SSE傳輸支持：為服務器與客戶端之間的通信提供了高效的方式。
• FastAPI風格的中間件支持：允許在整個應用程序中添加行為，增強應用的擴展性。
• 輕鬆集成現有應用：能夠與現有Starlette應用程序輕鬆集成，降低開發成本。
• 交互式文檔頁面：用於探索和測試工具，方便開發者進行調試和驗證。

📦 安裝指南

pip install ezmcp

💻 使用示例

基礎用法

from ezmcp import ezmcp, TextContent

# 創建一個ezmcp應用程序
app = ezmcp("my-app")

# 定義一個工具
@app.tool(description="Echo a message back to the user")
async def echo(message: str):
    """回顯用戶的消息."""
    return [TextContent(type="text", text=f"Echo: {message}")]

# 運行應用程序
if __name__ == "__main__":
    app.run(host="0.0.0.0", port=8000)

高級用法

from starlette.requests import Request

from ezmcp import TextContent, ezmcp

app = ezmcp("my-app")

@app.middleware
async def process_time_middleware(request: Request, call_next):
    """在響應中添加處理時間頭."""
    import time
    start_time = time.perf_counter()
    response = await call_next(request)
    process_time = time.perf_counter() - start_time
    response.headers["X-Process-Time"] = str(process_time)
    return response

@app.tool(description="Echo a message back to the user")
async def echo(message: str):
    """回顯用戶的消息."""
    return [TextContent(type="text", text=f"Echo: {message}")]

有關中間件的更多信息，請參閱middleware.md。

📚 詳細文檔

更多詳細信息請查閱ezmcp/README.md文件。

📄 許可證

本項目採用MIT許可證。

🔧 命令

• 使用測試環境安裝：pdm install -G test
• 使用開發環境安裝：pdm install -G dev