Fitness Api

🚀 MCP Server

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

🚀 快速開始

本 MCP 服務器可幫助你基於特定的 OpenAPI URL 開展相關工作，以下是詳細的使用指引。

✨ 主要特性

• 針對特定 OpenAPI URL 自動生成 MCP 服務器。
• 支持多種傳輸模式，如 stdio、sse、streamable-http。
• 可通過環境變量靈活配置服務器。

📦 安裝指南

前提條件

• 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]"
   

💻 使用示例

基礎用法

啟動服務器

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 腳本執行。

🔧 技術細節

本項目使用 ruff 進行代碼檢查和格式化，mypy 進行靜態類型檢查，pytest 進行測試。

代碼檢查和格式化

若要檢查代碼中的問題，可運行以下命令：

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

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