Transport Department Puducherry

🚀 MCP Server

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

🚀 快速開始

本MCP服務器可以幫助你基於特定的OpenAPI URL進行相關操作，下面將詳細介紹其安裝、開發、運行等步驟。

✨ 主要特性

• 基於給定的OpenAPI URL自動生成。
• 支持多種傳輸模式，如 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]"
   

💻 使用示例

基礎用法

代碼檢查

ruff check

代碼格式化

ruff format

運行靜態分析

./scripts/static-analysis.sh

運行測試並生成覆蓋率報告

./scripts/test.sh

運行測試並進行合併報告和清理

./scripts/test-cov.sh

安裝預提交鉤子

pre-commit install

啟動服務器（以stdio模式為例）

python mcp_server/main.py stdio

高級用法

構建項目

hatch build

發佈項目

hatch publish

📚 詳細文檔

開發相關

本項目使用 ruff 進行代碼檢查和格式化，mypy 進行靜態類型檢查，pytest 進行測試。相關命令可以通過腳本執行，也可以手動運行。

運行服務器

MCP服務器可以使用 mcp_server/main.py 腳本啟動，支持不同的傳輸模式。服務器可以通過環境變量進行配置：

• 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進行構建和發佈，相關命令也可以通過 scripts/publish.sh 腳本執行。