MCP Openapi Schema Explorer

🚀 使用 MCP 資源模板探索 OpenAPI 規範

本項目提供了 MCP 資源模板，可用於探索和理解 OpenAPI 規範，讓你輕鬆獲取 API 的各種信息並進行深入分析。

🚀 快速開始

📦 安裝依賴

pip install -r requirements.txt

⚙️ 啟動服務

python server.py

✨ 主要特性

MCP 提供了多個資源模板，用於探索和理解 OpenAPI 規範。以下是各個資源模板的詳細說明：

openapi://{field}

• 描述：此模板用於訪問 OpenAPI 文檔中的頂層字段（如 info、servers、tags）或列出 paths 和 components 的內容。具體可用字段取決於加載的規範。
• 示例：
  • 請求：openapi://info
  • 響應：以 JSON/YAML/minified JSON 格式返回 info 字段的內容。
  • 自動完成：提供 {field} 的動態建議，基於實際文檔中的頂層鍵。
• 參數：無

openapi://paths/{path}

• 描述：列出特定 API 路徑支持的所有 HTTP 方法（操作）。
• 參數：
  • {path}：API 路徑字符串。必須 URL 編碼（例如，/users/{id} 應編碼為 users%2F%7Bid%7D）。
• 示例：
  • 請求：openapi://paths/users%2F%7Bid%7D
  • 響應：以文本形式列出該路徑支持的所有 HTTP 方法。
  • 自動完成：提供 {path} 的動態建議，基於文檔中的所有路徑（URL 編碼後）。

openapi://paths/{path}/{method*}

• 描述：獲取特定 API 路徑上一個或多個 HTTP 方法的詳細規範。
• 參數：
  • {path}：API 路徑字符串。必須 URL 編碼。
  • {method*}：一個或多個 HTTP 方法（如 get、post），支持逗號分隔（例如，get,post）。不區分大小寫。
• 示例：
  • 單個方法：openapi://paths/users%2F%7Bid%7D/get
  • 多個方法：openapi://paths/users%2F%7Bid%7D/get,post
• 輸出格式：以 JSON/YAML/minified JSON 格式返回詳細規範。
• 自動完成：提供 {path} 的動態建議，以及 {method*} 的靜態建議（常見 HTTP 謂詞如 GET、POST、PUT、DELETE 等）。

openapi://components/{type}

• 描述：列出特定類型的所有定義組件（例如，schemas、responses、parameters），並附有簡短描述。具體可用類型取決於加載的規範。
• 示例：
  • 請求：openapi://components/schemas
  • 響應：以文本形式列出所有 schemas 類型的組件及其描述。
  • 自動完成：提供 {type} 的動態建議，基於文檔中的組件類型。

openapi://components/{type}/{name}

• 描述：獲取特定組件類型的詳細信息，例如 schema、response 或 parameter 的具體定義。
• 參數：
  • {type}：組件的類型（如 schemas）。
  • {name}：組件的具體名稱或標識符。
• 示例：
  • 請求：openapi://components/schemas/User
  • 響應：以 JSON/YAML 格式返回 User 構件的詳細定義。

🔧 貢獻指南

💻 提交代碼

git clone https://github.com/yourusername/mcp.git
cd mcp

🛠️ 開發流程

# 安裝依賴
pip install -r requirements.txt

# 啟動開發服務器
python server.py

🚀 發佈流程

📦 打包

python setup.py sdist bdist_wheel

🚀 發佈到 PyPI

twine upload dist/*

🚀 未來計劃

• 支持更多 OpenAPI 版本。
• 增加對其他 API 格式的解析能力。
• 提供交互式界面以提升用戶體驗。