Skip to main content
Glama
deenesjakoruzh
mcpland

storybook-mcp

by mcpland
OverviewSchemaRelated ServersScoreDiscussions
TypeScript
Hybrid

Storybook MCP Server

Node CI npm license

Ein Model Context Protocol (MCP) Server, der Tools zur Interaktion mit Storybook-Dokumentationen und Komponenteninformationen bereitstellt.

Funktionen

  • getComponentList: Ruft eine Liste aller Komponenten aus einem konfigurierten Storybook ab

  • getComponentsProps: Ruft detaillierte Informationen zu Props für mehrere Komponenten mithilfe von Headless-Browser-Automatisierung ab

  • Custom Tools: Erstellen Sie benutzerdefinierte Tools, die mithilfe von JavaScript beliebige Informationen aus Ihren Storybook-Seiten extrahieren können

Related MCP server: dbt-mcp

Installation und Konfiguration

MCP-Einstellungen

Fügen Sie die folgende Konfiguration zu den MCP-Einstellungen hinzu:

{
  "mcpServers": {
    "storybook": {
      "command": "npx",
      "args": ["-y", "storybook-mcp@latest"],
      "env": {
        "STORYBOOK_URL": "<your_storybook_url>/index.json"
      }
    }
  }
}

storybook-mcp startet sofort und installiert beim ersten Ausführen Chromium im Hintergrund. Wenn Sie den Browser vorab installieren möchten, führen Sie npx -y storybook-mcp@latest install-browser aus. Bis dieser Download abgeschlossen ist, kann der erste Aufruf eines browserbasierten Tools länger dauern.

Umgebungsvariablen

  • STORYBOOK_URL (erforderlich): Die URL zu der index.json-Datei Ihres Storybooks

  • CUSTOM_TOOLS (optional): JSON-Array mit Definitionen für benutzerdefinierte Tools zum Extrahieren spezifischer Informationen aus Ihrem Storybook

Verwendung

Der Server bietet integrierte Tools und unterstützt benutzerdefinierte Tools:

Integrierte Tools

1. getComponentList

Ruft eine Liste aller verfügbaren Komponenten aus dem konfigurierten Storybook ab.

Beispiel:

Available components:
Accordion
Avatar
Badge
Button
...

2. getComponentsProps

Ruft detaillierte Informationen zu Props für mehrere Komponenten ab, einschließlich:

  • Eigenschaftsnamen

  • Typen

  • Standardwerte

  • Beschreibungen

  • Status (erforderlich/optional)

Parameter:

  • componentNames (Array von Strings): Array der Komponentennamen, für die Informationen zu den Props abgerufen werden sollen

Beispiel für die Verwendung:

Tool: getComponentsProps
Parameters: { "componentNames": ["Button", "Input", "Avatar"] }

Benutzerdefinierte Tools

Sie können benutzerdefinierte Tools definieren, um spezifische Informationen aus Ihren Storybook-Seiten zu extrahieren. Jedes benutzerdefinierte Tool kann:

  • Zu einer beliebigen Seite in Ihrem Storybook navigieren

  • Benutzerdefiniertes JavaScript ausführen, um Daten zu extrahieren

  • Strukturierte Daten an den KI-Assistenten zurückgeben

Struktur benutzerdefinierter Tools:

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
}

Beispiel für benutzerdefinierte Tools:

[
  {
    "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 }))"
  }
]

Weitere Beispiele und eine detaillierte Dokumentation finden Sie unter examples/custom-tools-example.md.

Beispiel

Konfigurieren Sie Spectrum storybook-mcp mit den Umgebungsvariablen STORYBOOK_URL und CUSTOM_TOOLS.

{
  "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)\"}]"
      }
    }
  }
}

Funktionsweise

  1. Komponentenliste: Der Server ruft die index.json-Datei des Storybooks ab (v3 ist stories.json) und extrahiert alle Komponenten, die als Typ "docs" markiert sind

  2. Props-Informationen: Für Komponenten-Props führt der Server folgende Schritte aus:

    • Findet die Dokumentations-ID der Komponente aus der index.json

    • Erstellt die iframe-URL für die Dokumentationsseite der Komponente

    • Verwendet Playwright, um die Seite in einem Headless-Browser zu laden

    • Extrahiert das HTML der Props-Tabelle aus der Dokumentation

Unterstützte Storybook-URLs

Der Server funktioniert mit jedem Storybook, das eine index.json-Datei bereitstellt (v3 ist stories.json). Gängige Muster:

  • https://your-storybook-domain.com/index.json

  • https://your-storybook-domain.com/storybook/index.json

Entwicklung

Lokale Entwicklung

  1. Repository klonen

  2. Abhängigkeiten installieren: yarn install

  3. Playwright-Browser installieren: yarn install:browser

  4. Umgebungsvariable setzen: export STORYBOOK_URL="your-storybook-url"

  5. Im Entwicklungsmodus ausführen: yarn dev

Hinweis: Sie können alternativ auch npx @modelcontextprotocol/inspector tsx src/index.ts anstelle von yarn dev verwenden, falls Sie dies bevorzugen.

Build

yarn build

Testen

yarn test

Anforderungen

  • Node.js 18.0.0 oder höher

  • Chromium-Browser, installiert durch Playwright

Fehlerbehandlung

Der Server enthält eine umfassende Fehlerbehandlung für:

  • Fehlende oder ungültige Storybook-URLs

  • Netzwerkverbindungsprobleme

  • Szenarien, in denen Komponenten nicht gefunden werden

  • Fehler bei der Playwright-Browser-Automatisierung

Lizenz

Storybook MCP ist MIT-lizenziert.

Available Tools

2 tools
getComponentListA

Get a list of all components from the configured Storybook

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

TDQS

A3.6/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations exist, and the description does not disclose any behavioral traits such as side effects, permissions, or constraints. It only states the basic action.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single, front-loaded sentence with no extraneous words. Efficient and clear.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given zero parameters and no output schema, the description is reasonably complete for a simple list tool, though it could mention the output format or read-only nature.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema has zero parameters and 100% coverage, so the description adds no param info. Baseline for 0 params is 4, and the description is consistent.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb 'Get', resource 'list of all components', and source 'configured Storybook', distinguishing it from sibling 'getComponentsProps' which likely focuses on props.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance is provided on when to use this tool versus the sibling 'getComponentsProps' or any other context. The description is purely functional without usage hints.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

getComponentsPropsB

Get props information for multiple components

ParametersJSON Schema
NameRequiredDescriptionDefault
componentNamesYesArray of component names to get props information for

TDQS

B3.2/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, and the description does not disclose any behavioral aspects such as read-only nature, error handling, or prerequisites. For a tool with no annotations, the description carries the full burden but fails to add context.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single sentence that is efficient and to the point, with no unnecessary words. For such a simple tool, this level of brevity is appropriate.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the low complexity (1 parameter, no output schema, no annotations), the description is minimally adequate but lacks any behavioral context or return format hints. It could be improved by noting the output structure or error cases.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the schema already documents the parameter. The description does not add meaning beyond what the schema provides, meeting the baseline for high coverage.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the verb 'Get' and the resource 'props information for multiple components'. It effectively distinguishes from the sibling tool 'getComponentList', which likely lists components rather than their props.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No guidance is provided on when to use this tool versus alternatives. The sibling tool 'getComponentList' is mentioned but not contrasted, leaving the agent to infer usage context.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server
RayrunBuild, deploy, and operate MCP servers without becoming an infrastructure team.ray.runAd

TDQS

B3.4/5.0
Disambiguation5/5

Each tool targets a distinct purpose: one returns component list, the other returns props information. No overlap.

Naming Consistency4/5

Both use 'get' prefix followed by a noun, but one uses singular 'ComponentList' and the other plural 'ComponentsProps', a minor inconsistency.

Tool Count3/5

Only 2 tools feels thin for a Storybook assistant; more tools like individual component details or stories would be expected for a richer surface.

Completeness3/5

Covers listing components and their props, but lacks operations like getting individual component details, searching, or accessing stories, leaving notable gaps.

Maintenance

ActivityInactive
ResponsivenessWithin a week

Resources

Unclaimed servers have limited discoverability.

Looking for Admin?

If you are the server author, to access and configure the admin panel.

Related MCP Connectors

Related MCP Servers

Appeared in Searches

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/mcpland/storybook-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server