Nuxt UI MCP Server

Nuxt UI MCP Server

このプロジェクトは、Nuxt UI のドキュメントとリソースを標準化された API 経由で公開する、Nuxt UI 向けの Model Context Protocol（MCP）サーバーを実装します。TypeScript と Express で構築され、@modelcontextprotocol/sdk を利用しています。

目次

• Nuxt UI MCP Server
  • 目次
  • 機能
  • 前提条件
  • インストール
    • 1. リポジトリをクローンします：
    • 2. 依存関係をインストールします：
  • サーバーの実行
    • ビルド
    • 起動（フォアグラウンド）
    • 起動（PM2 でバックグラウンド実行）
    • 停止（バックグラウンド／PM2）
    • PM2 プロセスの削除
    • PM2 ログの表示
    • 開発モード
  • 環境変数
  • テスト
  • コントリビューション
  • ライセンス

機能

• MCP エンドポイント経由で Nuxt UI のドキュメントとリソースを提供します
• Express ベースの HTTP サーバー
• MCP 経由のセッションベースのストリーミングに対応しています

前提条件

• Node.js v18 以上
• npm v9 以上

インストール

1. リポジトリをクローンします：

git clone <your-fork-or-repo-url>
cd nuxt-ui-mcp

2. 依存関係をインストールします：

npm install

サーバーの実行

ビルド

まず、TypeScript のソースをコンパイルします：

npm run build

起動（フォアグラウンド）

npm start

起動（PM2 でバックグラウンド実行）

npm run start:bg

停止（バックグラウンド／PM2）

npm run stop:bg

PM2 プロセスの削除

npm run delete:bg

PM2 ログの表示

npm run logs:bg

開発モード

サーバーと MCP インスペクターを同時に実行します：

npm run dev

サーバーは、DEFAULT_PORT 環境変数で指定されたポートでリッスンします。設定されていない場合は 3000 を使用します。

環境変数

デフォルト値を変更する必要がある場合は、プロジェクトのルートに .env ファイルを作成します。例：

DEFAULT_PORT=3000

テスト

現在、このプロジェクトには自動テストやテストスクリプトはありません。テストへのコントリビューションを希望する場合は、コントリビューションセクションをご覧ください。

コントリビューション

1. このリポジトリをフォークし、機能追加または修正用の新しいブランチを作成します。
2. Node.js と npm がインストールされていることを確認します。
3. npm install を実行して依存関係をインストールします。
4. PR を提出する前に、npm run build を使用して TypeScript をコンパイルします。
5. 既存のコードスタイルと TypeScript の厳格さに従ってください（tsconfig.json を参照）。
6. 機能を追加する場合やバグを修正する場合は、PR の説明に変更内容を記載してください。

ライセンス

MIT