Mineskin Api

🚀 MCP Server

本項目是一個MCP（模型上下文協議）服務器，針對給定的OpenAPI URL - https://api.apis.guru/v2/specs/mineskin.org/1.0.0/openapi.json 構建，使用AG2的 MCP構建器 自動生成。

🚀 快速開始

本項目是基於特定OpenAPI URL的MCP服務器，能為相關應用提供必要的協議服務。以下將詳細介紹其安裝、開發、運行等方面的內容。

✨ 主要特性

• 支持基於給定的OpenAPI URL生成MCP服務器。
• 提供多種開發工具進行代碼檢查、格式化、靜態分析和測試。
• 支持不同的傳輸模式啟動服務器。
• 可通過環境變量配置服務器。
• 使用Hatch進行項目的構建和發佈。

📦 安裝指南

前提條件

• Python 3.9+
• pip 和 uv

安裝步驟

1. 克隆倉庫：

   git clone <repository-url>
   cd mcp-server
   

2. 安裝依賴： .devcontainer/setup.sh 腳本使用 pip install -e ".[dev]" 來安裝依賴。如果你不使用開發容器，可以手動運行此命令。

   pip install -e ".[dev]"
   

   或者，你也可以使用 uv：

   uv pip install --editable ".[dev]"
   

💻 使用示例

開發相關操作

代碼檢查與格式化

• 檢查代碼是否存在格式問題：

  ruff check
  

• 格式化代碼：

  ruff format
  

  這些命令也可以通過 scripts/lint.sh 腳本執行。

靜態分析

運行靜態分析（mypy、bandit、semgrep）：

./scripts/static-analysis.sh

此腳本也在 .pre-commit-config.yaml 中配置為預提交鉤子。

運行測試

• 運行帶覆蓋率的測試：

  ./scripts/test.sh
  

  這將運行pytest並生成覆蓋率報告。若要生成合並報告並清理，可以使用：

  ./scripts/test-cov.sh
  

預提交鉤子

本項目使用 .pre-commit-config.yaml 中定義的預提交鉤子。安裝鉤子：

pre-commit install

鉤子將在每次提交前自動運行。

運行服務器

MCP服務器可以使用 mcp_server/main.py 腳本啟動，支持不同的傳輸模式（如 stdio、sse、streamable-http）。

啟動服務器（例如，以stdio模式）：

python mcp_server/main.py stdio

服務器可以使用環境變量進行配置：

• CONFIG_PATH：JSON配置文件的路徑（例如，mcp_server/mcp_config.json）。
• CONFIG：包含配置的JSON字符串。
• SECURITY：用於安全參數的環境變量（例如，API密鑰）。

有關如何加載這些配置的詳細信息，請參考 mcp_server/main.py 中的 if __name__ == "__main__": 塊。

tests/test_mcp_server.py 文件展示瞭如何以編程方式啟動和與服務器進行交互以進行測試。

構建和發佈

本項目使用Hatch進行構建和發佈。

• 構建項目：

  hatch build
  

• 發佈項目：

  hatch publish
  

  這些命令也可以通過 scripts/publish.sh 腳本執行。