Storybook组件上下文协议
一个模型上下文协议服务器,它与Storybook集成,帮助AI工具查询UI组件并从静态Storybook文件中检索使用示例。
服务介绍
Storybook MCP 服务器
⚠️ 该工具是为测试目的创建的,不建议在生产环境中使用。
入门
在开始之前,您需要准备好您的 Storybook 静态文件。
https://storybook.js.org/docs/sharing/publish-storybook
1. 克隆仓库
git clone https://github.com/m-yoshiro/storybook-mcp.git
cd storybook-mcp
2. 安装依赖
我们推荐使用 Bun
bun install
# or
npm install
3. 构建
bun run build
# or
npm run build
4. 设置
{
"mcpServers": {
"storybook-mcp": {
"command": "node",
"args": [
"/< your path>/index.js",
// Optional: path to your Storybook static json file
"/< your path>/index.json"
]
}
}
}
服务器将加载您的 Storybook 数据,并向外部代理公开 MCP 工具。
🔧 可用工具
| 工具名称 | 描述 | 参数 |
|---|---|---|
list-components |
列出 Storybook 中所有可用的组件 | path (可选): index.json 或 stories.json 文件的路径(如果提供了默认路径,则为可选) |
find-components-by-name |
根据关键字查找组件(支持部分匹配) | name: 要搜索的组件名称或关键字path (可选): index.json 或 stories.json 文件的路径(如果提供了默认路径,则为可选) |