Superiorapis

🚀 SuperiorAPIs MCP 服務器工具

這是一款基於 Python 開發的 MCP 服務器，它能夠從 SuperiorAPIs 動態獲取插件定義，並依據 OpenAPI 模式自動生成 MCP 工具函數，為 MCP 服務器的搭建和運行提供了高效便捷的解決方案。

🚀 快速開始

運行 MCP 服務器，可按以下步驟操作：

1. 克隆項目並安裝依賴：

git clone https://your-repo-url.git
cd your-repo
pip install -r requirements.txt

2. 設置環境變量：
   • Linux/macOS

export TOKEN=your_token_here
export APPLICATION_ID=your_application_id_here

- **Windows CMD**

set TOKEN=your_token_here
set APPLICATION_ID=your_application_id_here

3. 運行 MCP 服務器：

python main.py

該服務器將依次完成從 SuperiorAPIs 獲取插件數據、動態生成 MCP 工具函數、註冊工具以及啟動 MCP 服務器的操作。

✨ 主要特性

• SuperiorAPIs 的動態插件加載：可靈活加載 SuperiorAPIs 的插件，提升服務器的擴展性。
• 基於 OpenAPI 模式的工具函數自動生成：依據 OpenAPI 模式自動創建 MCP 工具函數，提高開發效率。
• 使用 aiohttp 的異步 API 執行：藉助 aiohttp 實現異步 API 執行，增強服務器的響應能力。
• 運行時 MCP 工具註冊：支持在運行時註冊 MCP 工具，方便靈活配置。
• 支持環境配置：可通過環境變量進行服務器的相關配置。
• 準備用於 UVX 平臺部署：為在 UVX 平臺部署做好了準備。

📦 安裝指南

克隆項目並安裝依賴：

git clone https://your-repo-url.git
cd your-repo
pip install -r requirements.txt

💻 使用示例

基礎用法

運行 MCP 服務器：

python main.py

該服務器將完成以下操作：

1. 從 SuperiorAPIs 獲取插件數據
2. 動態生成 MCP 工具函數
3. 註冊工具
4. 啟動 MCP 服務器

示例生成工具函數

@mcp.tool()
async def post_example_tool(param1: Optional[str] = None, param2: Optional[int] = None) -> str:
    """
    工具描述 | API 概要。

    # 參數：
        param1 (string, 可選): param1 的描述。
        param2 (integer, 可選): param2 的描述。

    # 返回值：
        200 (object): API 響應。
    """

📚 詳細文檔

項目結構

.
├── main.py                 # MCP 服務器核心邏輯
├── requirements.txt        # Python 依賴列表
├── setup.py                # 包裝設置
├── Dockerfile              # （可選）Docker 容器構建文件
└── README.md               # 項目文檔

環境變量

運行前設置以下環境變量：

• Linux/macOS

export TOKEN=your_token_here
export APPLICATION_ID=your_application_id_here

• Windows CMD

set TOKEN=your_token_here
set APPLICATION_ID=your_application_id_here

API 端點

插件定義從以下地址獲取：

https://superiorapis-creator.cteam.com.tw/manager/module/plugins/list_v2

通過 token 頭進行授權。

依賴項

aiohttp>=3.8.6
pydantic>=2.5.3
mcp-sdk>=0.1.0

包裝（可選）

構建包：

python setup.py sdist bdist_wheel

安裝包：

pip install dist/mcp-superiorapis-1.0.0-py3-none-any.whl

使用 Docker 運行（如果需要）：

docker build -t superiorapis-mcp .
docker run -e TOKEN=your_token -e APPLICATION_ID=your_app_id superiorapis-mcp

錯誤處理

如果 API 調用失敗或返回 status: 0，程序將退出並顯示：

❌ 錯誤：API 返回無數據或狀態為 0。請檢查 API 是否正常工作。

📄 許可證

MIT License（或您自定義的許可證）

👨‍💻 作者

您的姓名 / 您的公司
聯繫郵箱：your_email@example.com