storybook-mcp
Storybook MCP サーバー
Storybook のドキュメントやコンポーネント情報とやり取りするためのツールを提供する Model Context Protocol (MCP) サーバーです。
機能
getComponentList: 設定された Storybook から全コンポーネントのリストを取得します
getComponentsProps: ヘッドレスブラウザの自動化を使用して、複数のコンポーネントの詳細な props 情報を取得します
Custom Tools: JavaScript を使用して Storybook ページから任意の情報を抽出できるカスタムツールを作成します
Related MCP server: dbt-mcp
インストールと設定
MCP 設定
MCP 設定に以下の構成を追加します:
{
"mcpServers": {
"storybook": {
"command": "npx",
"args": ["-y", "storybook-mcp@latest"],
"env": {
"STORYBOOK_URL": "<your_storybook_url>/index.json"
}
}
}
}storybook-mcp は起動直後にバックグラウンドで Chromium をインストールします。ブラウザを事前にインストールしておきたい場合は、npx -y storybook-mcp@latest install-browser を実行してください。ダウンロードが完了するまで、ブラウザを使用する最初のツール呼び出しに時間がかかる場合があります。
環境変数
STORYBOOK_URL(必須): Storybook のindex.jsonファイルへの URLCUSTOM_TOOLS(任意): Storybook から特定の情報を抽出するためのカスタムツール定義の JSON 配列
使用方法
このサーバーは組み込みツールを提供し、カスタムツールもサポートしています:
組み込みツール
1. getComponentList
設定された Storybook から利用可能な全コンポーネントのリストを取得します。
例:
Available components:
Accordion
Avatar
Badge
Button
...2. getComponentsProps
複数のコンポーネントの詳細な props 情報を取得します。これには以下が含まれます:
プロパティ名
型
デフォルト値
説明
必須/任意ステータス
パラメータ:
componentNames(文字列の配列): props 情報を取得するコンポーネント名の配列
使用例:
Tool: getComponentsProps
Parameters: { "componentNames": ["Button", "Input", "Avatar"] }カスタムツール
Storybook ページから特定の情報を抽出するためのカスタムツールを定義できます。各カスタムツールは以下のことが可能です:
Storybook 内の任意のページへ移動
カスタム JavaScript を実行してデータを抽出
AI アシスタントに構造化データを返す
カスタムツールの構造:
interface CustomTool {
name: string; // Unique tool name
description: string; // Tool description for the AI
parameters: object; // Input parameters schema (optional)
page: string; // URL to navigate to
handler: string; // JavaScript code to execute on the page
}カスタムツールの例:
[
{
"name": "getIconList",
"description": "Get All Icons from the Icon page",
"parameters": {},
"page": "https://your-storybook.com/?path=/docs/icon--docs",
"handler": "Array.from(document.querySelectorAll('.icon-name')).map(i => i.textContent)"
},
{
"name": "getColorPalette",
"description": "Extract color palette from design tokens",
"parameters": {},
"page": "https://your-storybook.com/?path=/docs/design-tokens--colors",
"handler": "Array.from(document.querySelectorAll('.color-swatch')).map(el => ({ name: el.getAttribute('data-color-name'), value: el.style.backgroundColor }))"
}
]その他の例や詳細なドキュメントについては、examples/custom-tools-example.md を参照してください。
例
STORYBOOK_URL と CUSTOM_TOOLS 環境変数を使用して Spectrum storybook-mcp 設定を行います。
{
"mcpServers": {
"storybook-mcp": {
"command": "npx",
"args": ["-y", "storybook-mcp@latest"],
"env": {
"STORYBOOK_URL": "https://opensource.adobe.com/spectrum-web-components/storybook/index.json",
"CUSTOM_TOOLS": "[{\"name\":\"getIconList\",\"description\":\"Get All Icons from the Icon page\",\"parameters\":{},\"page\":\"https://opensource.adobe.com/spectrum-web-components/storybook/iframe.html?viewMode=docs&id=icons--docs&globals=\",\"handler\":\"Array.from(document.querySelector('icons-demo').shadowRoot.querySelectorAll('.icon')).map(i => i.textContent)\"}]"
}
}
}
}仕組み
コンポーネントリスト: サーバーは Storybook の
index.jsonファイル(v3 はstories.json)を取得し、「docs」タイプとしてマークされたすべてのコンポーネントを抽出しますProps 情報: コンポーネントの props について、サーバーは以下を行います:
index.json からコンポーネントのドキュメント ID を検索
コンポーネントのドキュメントページ用の iframe URL を構築
Playwright を使用してヘッドレスブラウザでページを読み込み
ドキュメントから props テーブルの HTML を抽出
サポートされている Storybook URL
このサーバーは index.json ファイル(v3 は stories.json)を公開しているすべての Storybook で動作します。一般的なパターン:
https://your-storybook-domain.com/index.jsonhttps://your-storybook-domain.com/storybook/index.json
開発
ローカル開発
リポジトリをクローン
依存関係をインストール:
yarn installPlaywright ブラウザをインストール:
yarn install:browser環境変数を設定:
export STORYBOOK_URL="your-storybook-url"開発モードで実行:
yarn dev
注: 必要に応じて
yarn devの代わりにnpx @modelcontextprotocol/inspector tsx src/index.tsを使用することもできます。
ビルド
yarn buildテスト
yarn test要件
Node.js 18.0.0 以上
Playwright によってインストールされた Chromium ブラウザ
エラーハンドリング
サーバーには以下に対する包括的なエラーハンドリングが含まれています:
Storybook URL の欠落または無効
ネットワーク接続の問題
コンポーネントが見つからないシナリオ
Playwright ブラウザ自動化の失敗
ライセンス
Storybook MCP は MIT ライセンス の下で提供されています。
Available Tools
2 toolsgetComponentListA
Get a list of all components from the configured Storybook
Inputs: no named parameters.
getComponentsPropsB
Get props information for multiple components
Inputs: componentNames (required).
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 2 tools
Each tool targets a distinct purpose: one returns component list, the other returns props information. No overlap.
Both use 'get' prefix followed by a noun, but one uses singular 'ComponentList' and the other plural 'ComponentsProps', a minor inconsistency.
Only 2 tools feels thin for a Storybook assistant; more tools like individual component details or stories would be expected for a richer surface.
Covers listing components and their props, but lacks operations like getting individual component details, searching, or accessing stories, leaving notable gaps.
Maintenance
Related MCP Connectors
Model Context Protocol server for Studex tools, notifications, and profile integrations
A Model Context Protocol server for Wix AI tools
Remote MCP server for AIStoryHub: stories, chapters, story bible, Voiceprints, AI generation.
MCP server for StyleKit styles, tokens, recipes, lint and repair over stdio or HTTP.
Related MCP Servers
- AlicenseBqualityDmaintenanceA Model Context Protocol server that integrates with Storybook to help AI tools query UI components and retrieve usage examples from static Storybook files.221MIT
- AlicenseBqualityBmaintenanceA MCP (Model Context Protocol) server for interacting with dbt.1620,615 PyPI624Apache 2.0
- AlicenseNot gradedqualityBmaintenanceA generic, modular server for implementing the Model Context Protocol (MCP).299 npm45ISC
- AlicenseNot gradedqualityDmaintenanceAn MCP server that enables AI assistants to browse Storybook components, manage stories, inspect props, and capture screenshots of components.163 npm15AGPL 3.0