Openapi X MCP

🚀 OpenAPI 與 MCP

從 OpenAPI 規範生成類型安全的 MCP（模型上下文協議）服務器，為你的開發工作提供便利。

🚀 快速開始

此包允許你根據 OpenAPI 規範生成和運行一個類型安全的 MCP 服務器。它提供了 CLI 工具，用於代碼生成、配置管理和服務器運行。如果你希望在你的 MCP 客戶端中使用外部配置，也可以通過單個命令將其添加到 IDE 或客戶端中。

✨ 主要特性

• 依據 OpenAPI 規範生成類型安全的 MCP 服務器。
• 提供 CLI 工具，涵蓋代碼生成、配置管理和服務器運行功能。
• 可通過單個命令將外部配置添加到 MCP 客戶端。

📦 安裝指南

npx -y -p @usemodel-dev/cli@latest

💻 使用示例

基礎用法

生成服務器代碼

從 OpenAPI 規範生成 MCP 服務器代碼：

npx -y -p @usemodel-dev/cli@latest cli generate <ABSOLUTE_PATH_TO_SPEC_YAML_OR_JSON>

這將在 cwd() 目錄下創建 MCP 服務器文件。

使用 npx 運行服務器

npx -y -p @usemodel-dev/cli@latest server

配置 MCP 客戶端設置

在你的 MCP 客戶端（如 Cursor、Windsurf 等）中添加或更新配置：

npx -y -p @usemodel-dev/cli@latest cli config add <client> '<config_json>'

其中：

• <client> 可以是：cursor、windsurf 或 claude
• <config_json> 是包含你配置的 JSON 字符串

示例：

# 為 Cursor 添加或更新服務器配置
npx -y -p @usemodel-dev/cli@latest cli config add cursor '{"@yourorg/mcp": {"url": "http://localhost:3000", "env": { "apiKey": "XXX" } } }'

移除配置

npx -y -p @usemodel-dev/cli@latest cli config remove <client> <servername>

示例：

# 從 Cursor 中移除服務器配置
npx -y -p @usemodel-dev/cli@latest cli config remove cursor @yourorg/mcp

高級用法

本地開發

1. 構建服務器：

pnpm build

注意：需要先運行生成命令再進行構建。

2. 啟動服務器：

pnpm start

這將在 http://localhost:3001 啟動服務器。

配置存儲位置

根據客戶端不同，配置存儲在以下位置：

所有配置均存儲在 mcpServers 鍵下的配置文件中。添加新配置時，它們會與現有配置合併；更新現有配置時，則會覆蓋。

環境變量

服務器使用 dotenv 管理配置。在項目根目錄創建一個 .env 文件，添加必要的環境變量即可。

🔧 技術細節

依賴項

• @modelcontextprotocol/sdk：用於 MCP 實現
• express：用於 Web 服務器框架
• openapi-typescript：用於 TypeScript 類型生成
• zod：用於運行時類型驗證

📄 許可證

MIT

包信息

當前版本：0.0.1

貢獻

該項目託管在 GitHub 上，地址為 https://github.com/@usemodel-dev/cli.git。歡迎提交問題或拉取請求。