Policy Analyzer Api

🚀 MCP 服務器

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

🚀 快速開始

本 MCP 服務器項目可用於特定 OpenAPI URL 的服務，藉助 AG2 的 MCP 構建器自動生成，具備完善的開發、測試、部署流程。

✨ 主要特性

• 自動根據 OpenAPI URL 生成 MCP 服務器。
• 支持多種依賴安裝方式，如 pip 和 uv。
• 採用 ruff 進行代碼檢查和格式化，mypy 進行靜態類型檢查，pytest 進行測試。
• 支持多種傳輸模式，如 stdio、sse、streamable-http。
• 可通過環境變量配置服務器。
• 使用 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]"
   

💻 使用示例

基礎用法

啟動服務器（以 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 文件展示瞭如何以編程方式啟動和與服務器交互進行測試。

📚 詳細文檔

開發相關

本項目使用 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

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

構建和發佈

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

hatch build

發佈項目：

hatch publish

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