mcpField
C
create-skill-from-repo

create-skill-from-repo

github.com/hairyfAgent 工作流26297 次安装2 周前更新
代码仓库

关于 create-skill-from-repo

此工作流将指定项目的文档整理为便于 Agent 使用的本地技能,并保留源仓库以便追踪更新。它适合需要将框架或项目知识转化为可检索参考资料的开发者。

主要功能

  1. 01同步并保留源仓库
  2. 02筛选核心技术文档
  3. 03生成模块化参考文件
  4. 04创建技能索引与元数据
  5. 05检查覆盖范围并注册技能

适用场景

  1. 01将框架文档整理为 Agent 参考资料
  2. 02为生成内容保留源仓库以便后续比对

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/hairyf/skills --skill create-skill-from-repo

安装后在 Claude Code 中输入/create-skill-from-repo确认已加载。

附带文件references/coverage-loop.md

详细介绍

从代码仓库创建技能

使用此工作流,可快速将框架或项目的逻辑与文档导入本地环境。当用户提供一个 <repo-url> 和一个尚不存在本地技能的 <skills-name> 时,即会触发此工作流。

🎯 目标

  1. 源代码持久化:将原始代码仓库保留在 sources/ 中,以便追踪和后续更新。
  2. 知识提炼:将密集的文档转换为面向 Agent 优化的 references/*.md(侧重 用法 和 原因,而非 安装)。
  3. 自动注册:确保新技能可立即通过 AGENTS.md 发现。

🛠 前置条件

  • 验证:确保 <repo-url> 有效,且 <skills-name> 使用 kebab-case。
  • 环境:验证 git 访问权限并确定项目根目录。

🔄 工作流

第 1 步:同步源代码
  1. 定义目标位置:sources/<submodule>。
  2. 同步逻辑:
  • 主要方式:git submodule add <repo-url> sources/<submodule>
  • 备用方式:如果工作区不是 git 仓库,则使用 git clone --depth 1 <repo-url> sources/<submodule>
  • 维护:如果目录存在但为空,则运行 git submodule update --init。
第 2 步:确定知识库
  1. 定位源代码根目录:扫描 sources/<submodule>/,查找 docs/、wiki/、README.md 或 packages/*/docs/。
  2. 筛选策略:
  • ✅ 包含:API 参考、核心概念、设计模式、最佳实践。
  • ❌ 排除:安装指南(与 Agent 无关)、贡献日志、赞助信息或营销宣传内容。
第 3 步:生成模块化技能

目标结构:skills/<skills-name>/[SKILL.md, GENERATION.md, references/]

  1. references/*.md 指南:
  • 原子性:每个文件只包含一个概念。
  • 命名:{category}-{concept}.md(例如 core-reactivity.md)。
  • 内容:必须包含 Frontmatter、简短说明、高质量的 代码片段和源 URL。
  1. SKILL.md 索引:
  • 创建一个中心入口,并将参考资料分类到 Core、Features 和 Advanced 表格中。
  1. GENERATION.md 元数据:
  • 记录 Git SHA、源路径和生成日期,以便后续比较差异。
第 4 步:覆盖检查循环
  1. 审查:将“源代码根目录”的导航树与生成的 references/ 进行对比。
  2. 补充:如果缺少重要模块(例如 Middleware、Auth、Error Handling),则针对这些模块重复第 3 步。
  3. 退出条件:覆盖主要 API 范围和架构支柱后即可停止。不要陷入边缘情况。
第 5 步:集成与交接
  1. **更新 AGENTS.md**:在项目根目录中查找 AGENTS.md(若不存在,则创建)。
  2. 注入技能条目:
### <skills-name>
- **Location**: `skills/<skills-name>/`
- **Description**: [Short description from SKILL.md]

  1. 完成报告:向用户总结输出内容(例如:“已生成 15 个参考文件,涵盖 Core 和 Advanced 模块”)。

💡 关键原则

  • 以 Agent 为中心的写作:面向 AI 读者撰写。优先保证技术准确性并提供代码示例,而非大段文字说明。
  • Kebab-Case:所有目录和文件名都必须严格使用 kebab-case。
  • 路径格式:始终使用正斜杠(/),以确保跨平台兼容性。
  • 增量更新就绪:保留 sources/ 中的克隆,以便日后使用 git diff 检查文档变更。

📚 参考资料

主题说明参考
覆盖标准“重要模块”的定义和停止条件覆盖检查循环
风格指南参考文件的详细写作风格风格指南

你希望我使用特定的代码仓库 URL 模拟运行此技能,并展示预期输出吗?

评论

支持 Markdown