Skip to main content
Glama
deenesjakoruzh
mcpland

storybook-mcp

by mcpland
OverviewSchemaRelated ServersScoreDiscussions
TypeScript
Hybrid

Servidor MCP de Storybook

Node CI npm license

Un servidor del Protocolo de Contexto de Modelo (MCP) que proporciona herramientas para interactuar con la documentación y la información de los componentes de Storybook.

Características

  • getComponentList: Obtiene una lista de todos los componentes de un Storybook configurado

  • getComponentsProps: Obtiene información detallada de las propiedades (props) de múltiples componentes utilizando automatización de navegador headless

  • Herramientas personalizadas: Crea herramientas personalizadas que pueden extraer cualquier información de tus páginas de Storybook usando JavaScript

Related MCP server: dbt-mcp

Instalación y configuración

Configuración de MCP

Añade la siguiente configuración a los ajustes de MCP:

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

storybook-mcp se inicia inmediatamente e instala Chromium en segundo plano la primera vez que se ejecuta. Si deseas preinstalar el navegador con antelación, ejecuta npx -y storybook-mcp@latest install-browser. Hasta que esa descarga finalice, la primera llamada a una herramienta basada en navegador puede tardar más tiempo.

Variables de entorno

  • STORYBOOK_URL (obligatorio): La URL a tu archivo index.json de Storybook

  • CUSTOM_TOOLS (opcional): Array JSON de definiciones de herramientas personalizadas para extraer información específica de tu Storybook

Uso

El servidor proporciona herramientas integradas y admite herramientas personalizadas:

Herramientas integradas

1. getComponentList

Recupera una lista de todos los componentes disponibles del Storybook configurado.

Ejemplo:

Available components:
Accordion
Avatar
Badge
Button
...

2. getComponentsProps

Obtiene información detallada de las propiedades para múltiples componentes, incluyendo:

  • Nombres de las propiedades

  • Tipos

  • Valores predeterminados

  • Descripciones

  • Estado de requerido/opcional

Parámetros:

  • componentNames (array de strings): Array de nombres de componentes para los cuales obtener información de propiedades

Ejemplo de uso:

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

Herramientas personalizadas

Puedes definir herramientas personalizadas para extraer información específica de tus páginas de Storybook. Cada herramienta personalizada puede:

  • Navegar a cualquier página de tu Storybook

  • Ejecutar JavaScript personalizado para extraer datos

  • Devolver datos estructurados al asistente de IA

Estructura de herramienta personalizada:

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
}

Ejemplo de herramientas personalizadas:

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

Para más ejemplos y documentación detallada, consulta examples/custom-tools-example.md.

Ejemplo

Configura Spectrum en la configuración de storybook-mcp con las variables de entorno STORYBOOK_URL y 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)\"}]"
      }
    }
  }
}

Cómo funciona

  1. Lista de componentes: El servidor obtiene el archivo index.json (v3 es stories.json) del Storybook y extrae todos los componentes marcados como tipo "docs"

  2. Información de propiedades: Para las propiedades de los componentes, el servidor:

    • Encuentra el ID de documentación del componente desde el index.json

    • Construye la URL del iframe para la página de documentación del componente

    • Utiliza Playwright para cargar la página en un navegador headless

    • Extrae el HTML de la tabla de propiedades de la documentación

URLs de Storybook compatibles

El servidor funciona con cualquier Storybook que exponga un archivo index.json (v3 es stories.json). Patrones comunes:

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

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

Desarrollo

Desarrollo local

  1. Clona el repositorio

  2. Instala las dependencias: yarn install

  3. Instala los navegadores de Playwright: yarn install:browser

  4. Establece la variable de entorno: export STORYBOOK_URL="your-storybook-url"

  5. Ejecuta en modo desarrollo: yarn dev

Nota: También puedes usar npx @modelcontextprotocol/inspector tsx src/index.ts en lugar de yarn dev si lo prefieres.

Construcción

yarn build

Pruebas

yarn test

Requisitos

  • Node.js 18.0.0 o superior

  • Navegador Chromium instalado por Playwright

Manejo de errores

El servidor incluye un manejo integral de errores para:

  • URLs de Storybook faltantes o inválidas

  • Problemas de conectividad de red

  • Escenarios donde no se encuentra el componente

  • Fallos en la automatización del navegador Playwright

Licencia

Storybook MCP tiene licencia MIT.

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