Mcp Yapi Server

mcp-yapi-server

Model Context Protocol (MCP) に基づく YApi 統合サーバーです。Cursor など、MCP に対応したエディターで YApi の API ドキュメントを直接検索できます。

✨ 機能特性

• 🔗 URL を直接貼り付け - 最も簡単な方法です！YApi のリンクを貼り付けるだけで検索できます
• 🔍 インターフェースの詳細を検索 - リクエスト／レスポンスパラメーターをすべて確認できます
• 📋 インターフェース一覧 - プロジェクト内のすべてのインターフェースを確認できます
• 🔎 インターフェースを検索 - キーワードで検索できます
• 🤖 AI による支援 - コードや型定義などを自動生成します

📦 インストール

npm install -g mcp-yapi-server

または、プロジェクトの依存関係としてインストールします。

npm install mcp-yapi-server

🚀 クイックスタート

1. インストール

npm install -g mcp-yapi-server

2. Cursor を設定

Cursor の設定に MCP サーバーの構成を追加します。

推奨方法 - ローカルインストール：

# 在项目目录中安装
npm install mcp-yapi-server

{
  "mcpServers": {
    "yapi": {
      "command": "node",
      "args": ["./node_modules/mcp-yapi-server/dist/index.js"],
      "env": {
        "YAPI_BASE_URL": "https://yapi.example.com",
        "YAPI_TOKEN": "your_token_here"
      }
    }
  }
}

または、グローバルインストール：

npm install -g mcp-yapi-server

{
  "mcpServers": {
    "yapi": {
      "command": "mcp-yapi-server",
      "env": {
        "YAPI_BASE_URL": "https://yapi.example.com",
        "YAPI_TOKEN": "your_token_here"
      }
    }
  }
}

⚠️ 注意: 依存関係を正しく解決できない可能性があるため、npx の使用は推奨しません。ローカルインストールまたはグローバルインストールを使用してください。

3. Cursor を再起動

4. 使い始める

Cursor に YApi のリンクを直接貼り付けます。

https://yapi.example.com/project/100/interface/api/12345

📚 ドキュメント

• クイックスタートガイド
• 使用ガイド
• トラブルシューティング

🔧 よくある質問

"No server info found"

原因: Node.js のバージョンが 18 未満です
解決策: nvm install 18 && nvm use 18

"请登录..."

原因: Token の設定が必要です
解決策: Cursor の設定で YAPI_TOKEN を設定します

詳しくはトラブルシューティングドキュメントをご覧ください。

🛠 開発

# 克隆项目
git clone https://github.com/TStoneLee/mcp-yapi-server.git
cd mcp-yapi-server

# 安装依赖
npm install

# 开发模式
npm run dev

# 构建
npm run build

📄 ライセンス

MIT ライセンス

🔗 関連リンク

• Model Context Protocol
• YApi 公式ドキュメント
• Cursor エディター