Mcphub Trw

🚀 MCPHub 項目文檔

MCPHub 是一款能簡化模型上下文協議（Model Context Protocol, MCP）服務器集成至人工智能應用流程的工具。它藉助四個核心組件，達成了將 MCP 功能無縫集成到各類人工智能應用的目標，同時確保了關注點的清晰分離與框架的靈活性。

🚀 快速開始

在開始使用 MCPHub 之前，請確保安裝了 Python 3.10 或更高版本以及 poetry。然後運行以下命令進行安裝：

poetry install

編輯 .mcphub.json 配置文件以指定要使用的 MCP 服務器和參數。

✨ 主要特性

核心組件

MCPHub 由以下四個核心組件構成：

1. Params Hub
   • 管理從 .mcphub.json 配置文件讀取的配置。
   • 定義要使用的 MCP 服務器以及如何進行設置。
   • 存儲服務器參數，如命令、參數和環境變量。
2. MCP 服務器管理器
   • 負責服務器的安裝和啟動。
   • 支持兩種類型的服務器：
     • 基於 TypeScript 的服務器（通過 npx 安裝）
     • 基於 Python 的服務器（通過 uv 從 GitHub 安裝）
   • 管理服務器生命週期和環境。
3. MCP 客戶端
   • 建立與 MCP 服務器的通信。
   • 使用標準輸入輸出（stdio）進行交互。
   • 處理兩種主要操作：
     • list_tools：發現可用的服務器工具。
     • call_tool：執行服務器工具。
4. 框架適配器
   • 將 MCP 工具轉換為特定框架的格式。
   • 支持多種人工智能框架：
     • OpenAI 代理
     • LangChain
     • Autogen

工作流程

1. 配置與設置
   • Params Hub 讀取配置文件。
   • 服務器管理器啟動所需的服務器。
   • 服務器開始運行並可供使用。
2. 通信
   • MCP 客戶端通過 stdio 連接到服務器。
   • 工具被發現並可供使用。
   • 請求和響應在客戶端與服務器之間流動。
3. 集成
   • 框架適配器將 MCP 工具轉換為特定框架的格式。
   • 人工智能應用程序通過其首選框架使用這些工具。
   • 工具通過已建立的通信通道執行。

💻 使用示例

基礎用法

從 MCP 服務器獲取工具列表並執行工具：

from mcphub import MCPHub

async def basic_usage():
    hub = MCPHub()
    
    # 獲取所有服務器
    servers = hub.list_servers()
    
    # 獲取特定 MCP 服務器的工具
    tools = await hub.list_tools(mcp_name="sequential-thinking-mcp")
    
    # 打印工具信息
    for tool in tools:
        print(f"工具名稱: {tool.name}")
        print(f"描述: {tool.description}")
        print(f"參數: {tool.parameters}")
        print("---")
    
    # 工具可以：
    # - 使用 cache_tools_list=True 進行緩存以提高性能
    # - 自動轉換為特定框架的格式
    # - 通過適配器直接與 AI 框架一起使用

asyncio.run(basic_usage())

高級用法

將 MCP 工具集成到 OpenAI、LangChain 和 Autogen 等流行框架中：

from mcphub import MCPHub, get_openai_proxy, get_langchain_proxy, get_autogen_proxy

async def advanced_usage():
    hub = MCPHub()
    
    # 獲取 OpenAI 代理
    openai_proxy = await get_openai_proxy(hub)
    
    # 獲取 LangChain 代理
    langchain_proxy = await get_langchain_proxy(hub)
    
    # 獲取 Autogen 代理
    autogen_proxy = await get_autogen_proxy(hub)

asyncio.run(advanced_usage())

📚 詳細文檔

貢獻指南

如何貢獻代碼

1. Fork 此倉庫。
2. 在您的本地副本中創建一個新的功能分支：git checkout -b feature/your-feature
3. 提交您的更改：git commit -m "添加新功能"
4. 推送到遠程倉庫：git push origin feature/your-feature
5. 創建 Pull Request。

如何報告問題

在 Issues 頁面創建一個新的問題，並描述您遇到的問題和復現步驟。

開發環境設置

安裝依賴

使用 poetry 管理依賴：

poetry install

運行測試

運行單元測試：

poetry run pytest tests/

執行格式檢查

運行代碼格式檢查（假設您已安裝 black 和 flake8）：

poetry run black .
poetry run flake8 .

📄 許可證

MCPHub 項目在 MIT License 下開源。

注意：以上內容為示例，實際項目請根據需求進行調整。