← Back to list

storybook-list-documentation
by jiezhiyong
use the`shadcn` CLI to run your own code registry, and use storybook for ui mangerment & testing
⭐ 1🍴 0📅 Jan 14, 2026
SKILL.md
name: storybook-list-documentation description: 列出 Storybook manifests 中的全部组件/文档条目(等价于 list-all-documentation),用于组件发现、盘点与测试覆盖率梳理。
Storybook:列出全部文档(基于 manifests)
本 Skill 不依赖 MCP Server。它通过读取 storybook-static/manifests/components.json(本地或远程)列出组件库中所有可用的文档条目,并输出一个便于浏览的 Markdown 索引。
该 Skill 的目标是替代 @storybook/mcp 的 docs 工具:list-all-documentation。
When to Use
- 需要快速了解“组件库里有哪些组件/blocks/文档条目”时
- 需要做文档覆盖率盘点(哪些组件缺文档/缺 stories)时
- 在生成测试用例前,先枚举有哪些组件可测、有哪些关键 stories 可用时
- 在 agent 不确定该用哪个组件时,先让它列出候选条目再继续决策
Instructions
配置 manifests 来源(优先级从高到低)
- 命令行参数:
--manifestsRoot <path|url>(临时覆盖) - 环境变量:
STORYBOOK_MANIFESTS_ROOT(推荐用于业务项目配置远端 manifests) - 默认值:
./storybook-static/manifests(本地开发默认路径)
本仓库已提供读取脚本:
tools/storybook-manifest-skill.mjs
执行步骤(必须按顺序)
-
优先使用配置的 manifests 路径
-
如果已设置环境变量
STORYBOOK_MANIFESTS_ROOT,直接运行:node tools/storybook-manifest-skill.mjs list -
如果使用默认本地路径,运行:
node tools/storybook-manifest-skill.mjs list -
如果需要临时覆盖路径,运行:
node tools/storybook-manifest-skill.mjs list --manifestsRoot <path|url>
-
-
若本地路径不存在/未产出 manifests,改用远程 manifestsRoot
-
方式一(推荐):设置环境变量(适合业务项目长期配置)
export STORYBOOK_MANIFESTS_ROOT=https://storybook.your-company.com/manifests node tools/storybook-manifest-skill.mjs list -
方式二:临时通过命令行参数指定
node tools/storybook-manifest-skill.mjs list --manifestsRoot https://storybook.your-company.com/manifests
-
-
把输出的 Markdown 索引作为结果返回
- 如果用户后续要“获取某个条目的详情”,提示他们使用条目里的
id,并切换到 Skillstorybook-get-documentation。
- 如果用户后续要“获取某个条目的详情”,提示他们使用条目里的
输出要求(重要)
- 输出必须包含:条目
name与id - 发现条目数量异常(例如 0 条)时,要提醒用户:
- 是否启用了
experimentalComponentsManifest - 是否执行过
storybook build并生成了storybook-static
- 是否启用了
Score
Total Score
55/100
Based on repository quality metrics
✓SKILL.md
SKILL.mdファイルが含まれている
+20
○LICENSE
ライセンスが設定されている
0/10
○説明文
100文字以上の説明がある
0/10
○人気
GitHub Stars 100以上
0/15
✓最近の活動
1ヶ月以内に更新
+10
○フォーク
10回以上フォークされている
0/5
✓Issue管理
オープンIssueが50未満
+5
✓言語
プログラミング言語が設定されている
+5
✓タグ
1つ以上のタグが設定されている
+5
Reviews
💬
Reviews coming soon



