Starwind UI MCP Server について
Starwind UI MCP Server は、Starwind UI v3 および Starwind Pro 向けの TypeScript 製 MCP サーバーで、Astro と React プロジェクトに対してフレームワークを意識したガイダンスを AI クライアントに提供します。AI クライアントで UI を構築する開発者が、最新のコンポーネント情報やドキュメントを参照する用途に向けられています。
主な機能
- 01既存プロジェクト向け v3 初期化コマンドの生成
- 02スタイル付きコンポーネント、primitives、Pro ブロックの検索
- 03インストールコマンドの生成(実行はしない)
- 04コンポーネント、Runtime、移行ドキュメントの取得
- 05v2 から v3 への移行ガイダンスの作成
活用シーン
- 01Astro または React プロジェクトへのコンポーネントの追加
- 02コンポーネントの正確なドキュメントや使用方法の確認
- 03Starwind UI v2 から v3 への移行
MCP 対応
本プロジェクトは MCP サーバーであり、starwind_init、starwind_add、starwind_search、starwind_docs、starwind_migrate などのツールを MCP クライアントに公開します。
設定
ローカルサーバーの設定はどのクライアントでも共通です。コピーしてクライアントの MCP 設定ファイルに貼り付けてください。
ツール
5掲載時のツール一覧 · 3 週間前に更新
| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
| cwd | string | いいえ | パッケージマネージャーとフレームワークの検出に使用するプロジェクトディレクトリ。 |
| packageManager | enum | いいえ | npm | pnpm | yarn |
| framework | enum | いいえ | 任意の CLI フレームワーク上書き指定。astro | react |
| pro | boolean | いいえ | 有料の Starwind Pro 認証を設定します。デフォルトは false です。 |
詳細
公式 MCP レジストリ
·
io.github.starwind-ui/mcp
Starwind UI v3 および Starwind Pro 向けの TypeScript 製 Model Context Protocol サーバーです。Astro および React プロジェクトに対応した最新のガイダンスを AI クライアントに提供します。
クイックスタート
クライアントの最新のセットアップガイドについては、Starwind UI MCP のドキュメントをご覧ください。
Codex(~/.codex/config.toml):
[mcp_servers.starwind_ui]
command = "npx"
args = ["-y", "@starwind-ui/mcp"]
enabled = true
Claude Code(.mcp.json)または Cursor(.cursor/mcp.json):
{
"mcpServers": {
"starwind-ui": {
"command": "npx",
"args": ["-y", "@starwind-ui/mcp"]
}
}
}
設定を変更した後は、クライアントを再起動するか、MCP サーバーを再読み込みしてください。
v3 モデル
Starwind UI v3 には、関連する3つの領域があります。MCP はこれらを区別して扱います。
| 領域 | 表すもの | MCP の動作 |
|---|---|---|
| スタイル付きコンポーネント | Astro および/または React の実装を含む、コピーして所有する UI コンポーネント | starwind_search で検索し、starwind_add でインストールします |
| プリミティブ | 必要に応じて Starwind Runtime を利用する、低レベルの Astro および React アダプター | surface: "primitive" で検索し、v3 の primitives add コマンドでインストールします |
| Runtime | フレームワークに依存しない動作 API | Runtime のトピックまたはサーフェスを指定して starwind_docs で取得します |
サーバーは、バージョン管理された ai-manifest.json に照らしてこれらのレイヤーを検証し、検証済みデータをキャッシュします。サイトが利用できない場合は、同梱の v3 スナップショットにフォールバックします。
ツール
| ツール | 目的 |
|---|---|
starwind_init | 既存の Astro または React プロジェクト向けに、v3 の初期化コマンドを生成します。Pro はオプトインです。 |
starwind_add | スタイル付きコンポーネント、プリミティブ、または Astro 専用 Pro ブロックのリクエストを検証し、インストールまたはインストール保留のコマンドを生成します。 |
starwind_search | フレームワークのメタデータとフィルターを使って、スタイル付きコンポーネント、プリミティブ、Pro ブロックを検索します。 |
starwind_docs | コンポーネント、プリミティブ、Runtime、移行、フレームワークに関する正確なドキュメントを解決します。 |
starwind_migrate | プロジェクトを調査し、安全性を重視した対話形式の v2 から v3 への移行ガイダンスを生成します。 |
ツールの呼び出しは、読みやすい JSON テキストと MCP の structuredContent の両方を返します。
要件と動作
- 生成される v3 CLI コマンドには、Node.js 22.12.0 以降が必要です。
starwind_initは既存の Astro 5+ または React 18+ プロジェクトを対象とします。frameworkが指定されていない場合、CLI がフレームワークを自動検出します。- 無料の
@starwind-pro/*カタログブロックは、通常の初期化後に使用できます。有料ブロックには明示的な認可が必要です。必要な場合に限り、pro: trueを渡してください。 - Starwind Pro ブロックは現在 Astro を対象としています。React の検索結果には含まれず、React の追加リクエストでは明示的に拒否されます。
- 移行はデフォルトで対話形式です。バックアップと上書きを意図している場合に限り、
yes: trueを設定してください。 - 可能な場合は、パッケージマネージャーとプロジェクトのコンテキストをローカルで検出し、追加コマンドでは解決されたパッケージマネージャーを CLI に渡します。ツールが生成したコマンドを実行することはありません。
無料版からProへのアップグレード
MCPでは、有料プランの利用を強制することなく、Proを見つけられるようにしています。検索結果にはProカタログへのリンクが表示され、無料のProブロックは引き続き直接インストールでき、有料の検索結果には購入リンクとインストールリンクを含む構造化されたproUpgradeの手順が表示されます。
既存のAstroプロジェクトには、MCPは次の手順を推奨します。
pnpm dlx starwind@latest setup --yes
セットアップコマンドはプロジェクトのパッケージマネージャーを自動検出するため、--package-managerフラグは不要です。Proレジストリと.env.localを準備します。STARWIND_LICENSE_KEYのプレースホルダーを購入したキーに置き換えてから、返されたdeferredCommandを実行してください。キーは機密情報として扱ってください。.env.localをソース管理に含めず、ログやクライアント側のコードでキーを公開しないでください。pro: trueを指定して初期化したプロジェクトには、代わりに同等のinit --proコマンドが提示されます。
開発
pnpm build
pnpm lint
pnpm test:run
オプトインの本番マニフェスト契約テストは、次のコマンドで実行します。
RUN_LIVE_CONTRACT_TESTS=1 pnpm test:run src/utils/starwind_live_contract.test.ts
ライセンス
MITです。LICENSEを参照してください。
セキュリティ
コメント
AI アプリケーションが外部のツールやデータソースに統一的な方法で接続するためのオープンなプロトコルです。クライアントはモデルとの対話を担い、MCP サーバーはツール・リソース・プロンプトテンプレートを提供します。標準メッセージでやり取りするため、1 つのサーバーを複数のクライアントで再利用できます。
