mcpField
L
legacy-to-ai-ready

legacy-to-ai-ready

github.com/nicepkgAgent 工作流288292 次安装40 周前更新
代码仓库

关于 legacy-to-ai-ready

将旧代码库整理为适用于 Claude Code 的项目配置,面向个人开发者和团队。它分析代码库约定,并引导生成 CLAUDE.md 及其他配置。

主要功能

  1. 01自动分析代码库
  2. 02引导创建 CLAUDE.md
  3. 03配置规则、技能、Agent 和命令
  4. 04配置钩子与权限
  5. 05发现技能和 MCP 资源

适用场景

  1. 01记录构建与测试约定
  2. 02为团队项目配置 Claude Code
  3. 03通过忽略规则保护敏感文件

MCP 相关

该技能可帮助识别并配置用于数据库、GitHub、Slack 和内部工具等外部集成的 MCP 服务。

安装

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

$npx skills add https://github.com/nicepkg/ai-workflow --skill legacy-to-ai-ready

安装后在 Claude Code 中输入/legacy-to-ai-ready确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

assets/
CLAUDE.md.template
claudeignore.template
settings.json.template
assets/resource-scout/references/
sources.md
assets/skill-creator/references/
output-patterns.md
workflows.md
assets/skill-creator/scripts/
init_skill.py
package_skill.py
quick_validate.py
assets/skill-downloader/scripts/
download_from_archive.py
download_from_github.py
download_skill.py
references/
advanced-patterns.md
agents-patterns.md
claude-md-patterns.md
commands-patterns.md
examples.md
hooks-patterns.md
mcp-patterns.md
resource-discovery.md
rules-patterns.md
skills-patterns.md
scripts/
analyze_codebase.py

详细介绍

从遗留项目到 AI 就绪

通过生成 Claude Code 配置,将遗留代码库转变为适合 AI 的项目。

快速入门(5 分钟设置)

对于大多数项目,只需从 CLAUDE.md 开始:

  1. 分析:python scripts/analyze_codebase.py [path]
  2. 创建 CLAUDE.md,写入构建命令、代码风格和架构概述
  3. 完成——Claude 现在可以按照项目规范编写代码

只有在需要时,才扩展为完整配置。

交互式探索

生成配置前,请先询问以下问题:

项目范围:

  • 这是一个什么项目?(Web 应用、API、CLI、库)
  • 主要语言和框架是什么?
  • 团队规模如何?(个人、小团队、企业)

痛点:

  • 新开发者通常会犯哪些错误?
  • 应始终遵循哪些模式?
  • 哪些操作会频繁重复?

集成需求:

  • 使用了哪些外部服务?(数据库、API、云服务)
  • 是否有 CI/CD 流水线?(GitHub Actions、Jenkins)
  • 使用了哪些代码质量工具?(linter、格式化工具)

配置决策树

Start
│
├─ Small project / Solo dev
│  └─ CLAUDE.md only
│
├─ Team project
│  ├─ Multi-language? → Add .claude/rules/
│  ├─ Complex domain? → Add .claude/skills/
│  ├─ Code reviews? → Add .claude/agents/
│  └─ Repeated tasks? → Add .claude/commands/
│
└─ Enterprise / Large team
   └─ All configurations + MCP servers + Hooks

生成的配置

配置用途创建时机
CLAUDE.md项目记忆(共享)始终创建(必需)
CLAUDE.local.md个人偏好(被 git 忽略)个人自定义
.claudeignoreClaude 不应访问的文件存在敏感文件时
.claude/rules/路径专属规则多模块项目
.claude/skills/领域知识复杂业务逻辑
.claude/agents/任务专家重复的审查/调试任务
.claude/commands/快捷提示词常见工作流
.claude/settings.jsonHooks + 权限自动格式化、安全防护
MCP servers外部工具数据库/API 集成

工作流

阶段 1:自动化分析
python scripts/analyze_codebase.py [project-path]

脚本会检测:

  • 语言和框架
  • 目录结构模式
  • 开发工具(linter、格式化工具)
  • Git 提交模式
  • 环境变量
  • 代码风格特征
  • CI/CD 配置(GitHub Actions 等)
  • 敏感文件(针对 .env、凭据发出警告)

输出包括:

  • 创建哪些配置的建议
  • 针对敏感文件的安全警告
  • 建议的 .claudeignore 模式
阶段 2:收集上下文

Claude 应读取:

  1. 3–5 个代表性源文件——了解命名和模式
  2. 测试文件——了解测试方法
  3. 配置文件——package.json、tsconfig 等
  4. README/文档——了解项目概况
  5. 近期提交记录——了解提交风格
阶段 2.5:发现现有资源

创建自定义配置前,先搜索现有技能和 MCP 服务:

  1. 搜索技能市场——SkillsMP、SkillHub.club、Claude Skills Hub
  2. 查看 GitHub 仓库——awesome-claude-skills、主题技能集合
  3. 查找相关 MCP 服务——Glama、MCP Market、官方注册表

完整的资源目录请参阅 references/resource-discovery.md。

提示:许多常见需求(Git 提交、代码审查、数据库模式)已经有维护良好的可用技能。

阶段 3:生成配置
1. CLAUDE.md(必需)

在项目根目录创建,并包含:

  • 快速参考命令(构建、测试、lint)
  • 命名规范
  • 架构概述
  • 测试指南
  • Git 工作流

请参阅 references/claude-md-patterns.md。

2. 规则(多模块项目适用)

在以下情况下创建 .claude/rules/:

  • 多种语言需要采用不同规范
  • 模块具有不同模式(前端/后端)
  • 存在路径专属要求

请参阅 references/rules-patterns.md。

3. 技能(适用于复杂领域)

在以下情况下创建 .claude/skills/:

  • 存在特定领域的工作流(数据库、API 模式)
  • 需要保留团队知识
  • 复杂流程需要反复执行

请参阅 references/skills-patterns.md。

4. 子 Agent(适用于专门任务)

为以下用途创建 .claude/agents/:

  • 自动化代码审查
  • 调试辅助
  • 安全审计
  • 文档生成

请参阅 references/agents-patterns.md。

5. 命令(适用于常见操作)

为以下用途创建 .claude/commands/:

  • Git 提交工作流
  • PR 审查流程
  • 部署步骤
  • 运行测试

请参阅 references/commands-patterns.md。

6. 钩子(适用于需要自动格式化的情况)

为以下用途配置 .claude/settings.json:

  • 编辑文件时自动格式化
  • 受保护的文件
  • 命令日志记录

请参阅 references/hooks-patterns.md。

7. MCP 服务(适用于外部集成)

为以下用途配置 MCP:

  • 数据库访问
  • GitHub 集成
  • Slack 通知
  • 自定义内部工具

请参阅 references/mcp-patterns.md。

阶段 4:验证
  1. 请 Claude 执行一项典型任务
  2. 验证它是否遵循项目约定
  3. 根据发现的差距进行迭代

输出结构

最简(小型项目):

project/
├── CLAUDE.md
└── [existing files]

标准(团队项目):

project/
├── CLAUDE.md
├── .claude/
│   ├── rules/
│   │   └── code-style.md
│   └── commands/
│       └── commit.md
└── [existing files]

完整(企业级):

project/
├── CLAUDE.md              # Shared project memory
├── CLAUDE.local.md        # Personal (git-ignored)
├── .claudeignore          # Files to protect
├── .claude/
│   ├── settings.json      # Hooks + permissions
│   ├── rules/
│   ├── skills/
│   ├── agents/
│   └── commands/
└── [existing files]

参考资料

参考资料阅读时机
examples.md完整的真实案例
resource-discovery.md查找现有技能和 MCP 服务
advanced-patterns.md迁移、团队协作、单体仓库
claude-md-patterns.md创建 CLAUDE.md
rules-patterns.md模块专属规则
skills-patterns.md领域知识
agents-patterns.md任务专家
commands-patterns.md快捷提示词
hooks-patterns.md自动格式化
mcp-patterns.md外部工具

模板和捆绑技能

模板:

  • assets/CLAUDE.md.template - 项目记忆模板
  • assets/settings.json.template - 钩子配置
  • assets/claudeignore.template - 文件忽略模式

要安装到目标项目中的捆绑技能:

  • assets/skill-creator/ - 用于创建新的项目专属技能
  • assets/skill-downloader/ - 用于下载其他技能
  • assets/resource-scout/ - 用于发现现有技能和 MCP 服务
安装捆绑技能

将这些技能复制到目标项目的 .claude/skills/ 目录:

cp -r assets/skill-creator [target-project]/.claude/skills/
cp -r assets/skill-downloader [target-project]/.claude/skills/
cp -r assets/resource-scout [target-project]/.claude/skills/

这样目标项目便可以:

  1. resource-scout - 在构建自定义技能之前,发现现有技能和 MCP 服务
  2. skill-downloader - 从 GitHub 或归档文件下载并安装技能
  3. skill-creator - 创建适合其领域的自定义技能

语言快速参考

TypeScript/JavaScript
  • 提取:eslint、prettier、tsconfig
  • 钩子:prettier 自动格式化
  • 技能:API 模式、组件模式
Python
  • 提取:black、ruff、mypy、pyproject.toml
  • 钩子:black/ruff 自动格式化
  • 技能:API 模式、ORM 模式
Go
  • 提取:gofmt、golangci-lint
  • 钩子:gofmt 自动格式化
  • 技能:错误处理模式
Rust
  • 提取:rustfmt、clippy
  • 钩子:rustfmt 自动格式化
  • 技能:错误处理、异步模式

评论

支持 Markdown