mcpField
R
rule-creator

rule-creator

github.com/oimiragieoAgent 工作流4480 次安装17 周前更新
代码仓库

关于 rule-creator

rule-creator 是用于在 `.claude/rules/` 中创建和维护项目规则的技能,包含检查与后续集成步骤。它适合为 Claude Code 制定编码规范、框架约定或团队工作流。

主要功能

  1. 01创建和更新 Markdown 规则
  2. 02检查现有规则及配套产物
  3. 03将规则登记到索引
  4. 04执行集成与创作者协同检查

适用场景

  1. 01制定项目编码规范
  2. 02记录框架约定
  3. 03建立团队工作流协议

安装

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

$npx skills add https://github.com/oimiragieo/agent-studio --skill rule-creator

安装后在 Claude Code 中输入/rule-creator确认已加载。

包含的文件

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

commands/
rule-creator.md
hooks/
post-execute.cjs
pre-execute.cjs
references/
research-requirements.md
rules/
rule-creator.md
schemas/
input.schema.json
output.schema.json
scripts/
main.cjs
templates/
implementation-template.md

详细介绍

规则创建器

在 .claude/rules/ 中创建规则文件。Claude Code 会自动发现这些规则,并将其加载到 Agent 上下文中。

步骤 0:检查是否已有规则

创建前,先检查规则是否已存在:

test -f .claude/rules/<rule-name>.md && echo "EXISTS" || echo "NEW"

如果已存在 → 使用 Read 检查当前规则文件,然后使用 Edit 直接应用更改。更新后运行创建后集成步骤(步骤 4)。

如果是新规则 → 继续执行步骤 0.5。

步骤 0.5:配套项检查

开始创建前,运行生态配套项检查:

  1. 使用 .claude/lib/creators/companion-check.cjs 中的 companion-check.cjs
  2. 调用 checkCompanions("rule", "{rule-name}") 以识别配套产物
  3. 查看配套项清单,记录缺失的必需项和推荐项
  4. 规划在此产物完成后创建或核实缺失的配套项
  5. 在创建后集成说明中包含配套项检查结果

此步骤仅用于提供信息(不会阻止创建),但可确保充分考虑整个产物生态。

适用场景

  • 创建项目专属的编码指南
  • 记录框架约定
  • 建立团队标准
  • 定义工作流协议

规则文件格式

规则是简单的 Markdown 文件:

# Rule Name

## Section 1

- Guideline 1
- Guideline 2

## Section 2

- Guideline 3
- Guideline 4

示例:testing.md

# Testing

## Test-Driven Development

- Use TDD for new features and bug fixes (Red-Green-Refactor cycle)
- Write failing test first, then minimal code to pass, then refactor
- Never write production code without a failing test first

## Test Organization

- Add unit tests for utilities and business logic
- Add integration tests for API boundaries
- Keep tests deterministic and isolated (no shared state)
- Place test files in `tests/` directory mirroring source structure

创建工作流

步骤 1:验证输入
// Validate rule name (lowercase, hyphens only)
const ruleName = args.name.toLowerCase().replace(/[^a-z0-9-]/g, '-');

// Validate content is not empty
if (!args.content || args.content.trim().length === 0) {
  throw new Error('Rule content cannot be empty');
}
步骤 2:创建规则文件
const rulePath = `.claude/rules/${ruleName}.md`;

// Format content as markdown
const content = args.content.startsWith('#')
  ? args.content
  : `# ${ruleName.replace(/-/g, ' ').replace(/\b\w/g, l => l.toUpperCase())}\n\n${args.content}`;

await writeFile(rulePath, content);
必须:在索引中登记
pnpm index-rules

确认 total_rules 计数已增加。规则只有编入索引后,Agent 才能发现它。

步骤 3:验证自动发现

Claude Code 会自动加载 .claude/rules/ 中的规则。无需手动登记。

// Verify file was created
const fileExists = await exists(rulePath);
if (!fileExists) {
  throw new Error('Rule file creation failed');
}
步骤 4:运行创建后集成
const {
  runIntegrationChecklist,
  queueCrossCreatorReview,
} = require('.claude/lib/creators/creator-commons.cjs');

await runIntegrationChecklist('rule', rulePath);
await queueCrossCreatorReview('rule', rulePath, {
  artifactName: ruleName,
  createdBy: 'rule-creator',
});

创建后集成

创建规则后,运行集成检查清单:

const {
  runIntegrationChecklist,
  queueCrossCreatorReview,
} = require('.claude/lib/creators/creator-commons.cjs');

// 1. Run integration checklist
const result = await runIntegrationChecklist('rule', '.claude/rules/<rule-name>.md');

// 2. Queue cross-creator review
await queueCrossCreatorReview('rule', '.claude/rules/<rule-name>.md', {
  artifactName: '<rule-name>',
  createdBy: 'rule-creator',
});

// 3. Review impact report
// Check result.mustHave for failures - address before marking complete

集成验证:

  • 已在 .claude/rules/ 中创建规则文件
  • Claude Code 可自动发现该规则
  • 规则内容清晰且可执行
  • 与现有规则不存在冲突

使用示例

创建代码标准规则
Skill({
  skill: 'rule-creator',
  args: `--name code-standards --content "# Code Standards

## Organization
- Prefer small, cohesive files over large ones
- Keep interfaces narrow; separate concerns by feature

## Style
- Favor immutability; avoid in-place mutation
- Validate inputs and handle errors explicitly"`,
});
创建 Git 工作流规则
Skill({
  skill: 'rule-creator',
  args: `--name git-workflow --content "# Git Workflow

## Commit Guidelines
- Keep changes scoped and reviewable
- Use conventional commits: feat:, fix:, refactor:, docs:, chore:

## Branch Workflow
- Create feature branches from main
- Never force-push to main/master"`,
});

相关技能

  • skill-creator - 创建详细工作流(适用于需要完整 SKILL.md 的复杂指南)
  • hook-creator - 创建与治理规则配套的强制执行钩子

铁律

  1. 每个产物都必须有配套的 schema — 没有 schema 的规则无法对结构化验证作出约定。如果规则会生成结构化输出或包含可配置参数,请在 .claude/schemas/ 中创建 JSON schema。
  2. 每个产物都必须关联至少一个 Agent — 未被任何 Agent 或技能引用的规则会成为孤立产物。确认该规则与至少一个 Agent 的上下文相关(.claude/rules/ 中的规则会自动加载,但领域专属规则应在 Agent 提示词中引用)。
  3. 每个产物都必须编入相应目录的索引 — 未在目录中追踪的规则难以发现和审查。添加条目,或确认规则已列入相应目录。
  4. 每个产物都必须通过集成验证 — 在标记创建完成前,运行 node .claude/tools/cli/validate-integration.cjs <rule-path>。验证失败的规则可能存在失效引用或冲突。
  5. 每个产物都必须记录一条记忆 — 将规则创建模式、决策和任何问题写入 .claude/context/memory/(learnings.md、decisions.md、issues.md)。不记录记忆,后续会话就无法了解这次创建。

记忆协议(必需)

开始前: 读取 .claude/context/memory/learnings.md

完成后:

  • 新规则模式 → .claude/context/memory/learnings.md
  • 规则创建问题 → .claude/context/memory/issues.md
  • 指南决策 → .claude/context/memory/decisions.md

假定工作会中断:如果没有记录在记忆中,就等于没有发生。

交叉引用:创作者生态

此技能属于 创作者生态。研究发现缺口时,请调用相应的配套创建器:

发现的缺口必需的产物要调用的创建器适用情形
领域知识需要转化为可复用的技能skillSkill({ skill: 'skill-creator' })缺口涵盖一个完整的技能领域
现有技能的覆盖范围不完整skill updateSkill({ skill: 'skill-updater' })已有相关技能,但内容不完整
某项能力需要专属 AgentagentSkill({ skill: 'agent-creator' })需要由 Agent 负责该能力
现有 Agent 需要更新能力agent updateSkill({ skill: 'agent-updater' })已有相关 Agent,但能力不完整
领域需要代码/项目脚手架templateSkill({ skill: 'template-creator' })需要可复用的代码模式
行为需要执行前/后的防护机制hookSkill({ skill: 'hook-creator' })需要强制执行行为
流程需要多阶段编排workflowSkill({ skill: 'workflow-creator' })需要多步骤协调
产物需要结构化的 I/O 验证schemaSkill({ skill: 'schema-creator' })需要用于产物 I/O 的 JSON schema
用户交互需要斜杠命令commandSkill({ skill: 'command-creator' })需要面向用户的快捷方式
重复逻辑需要可复用的 CLI 工具toolSkill({ skill: 'tool-creator' })需要 CLI 实用工具
仅适用于范围狭窄/单一产物的能力inline仅在此产物中记录特定性过强,无法泛化

生态对齐契约(强制)

此创建器技能属于协同运作的创作者生态。此处创建的任何产物都必须与相关创建器保持一致,并通过其验证:

  • agent-creator:负责归属和执行路径
  • skill-creator:负责能力打包和分配
  • tool-creator:负责可执行自动化接口
  • hook-creator:负责强制执行和防护措施
  • rule-creator 和 semgrep-rule-creator:负责策略和静态检查
  • template-creator:负责标准化脚手架
  • workflow-creator:负责编排和阶段门控
  • command-creator:负责面向用户/操作者的命令 UX
跨创建器交接(必需)

完成前,请验证所有相关交接:

  1. 产物路由已添加到 .claude/CLAUDE.md 和相关路由文档中。
  2. 已更新发现/注册信息(视情况更新目录/索引/注册表)。
  3. 已创建配套产物,或明确说明豁免原因。
  4. 为所创建的产物运行 validate-integration.cjs 并通过验证。
  5. 技能元数据发生变化时,重新生成技能索引。
Research Gate(Exa + arXiv — 两者均为必需)

对于新的模式、模板或工作流,必须进行调研:

  1. 使用 Exa 研究实现方式和生态系统模式:
    • mcp__Exa__web_search_exa({ query: '<topic> 2025 best practices' })
    • mcp__Exa__get_code_context_exa({ query: '<topic> implementation examples' })
  2. 搜索 arXiv 上的学术研究(AI/ML、Agent、评估、编排、记忆/RAG、安全相关主题均为必需):
    • 通过 Exa:mcp__Exa__web_search_exa({ query: 'site:arxiv.org <topic> 2024 2025' })
    • 直接调用 API:WebFetch({ url: 'https://arxiv.org/search/?query=<topic>&searchtype=all&start=0' })
  3. 在制品引用/文档中记录决策、约束和非目标。
  4. 尽量减少更新,避免过度设计。

主题涉及以下内容时,必须搜索 arXiv(不得作为备选): AI Agent、大模型评估、编排、记忆/RAG、安全、静态分析或任何新兴方法。

安全回归交付
  • 行为变更严格遵循 RED -> GREEN -> REFACTOR 流程。
  • 针对变更模块运行测试。
  • 对变更文件运行 lint/format。
  • 按关注点划分提交(逻辑/文档/生成的制品)。

评论

支持 Markdown