Eval Rules logo

Eval Rules

CommunityPopular
FlorianBruniaux
eval-rules

Audit .claude/rules/ files for structural correctness, glob validity, and real-world usefulness. Resolves each paths: pattern against actual project files, then asks the user whether each rule is still relevant and useful. Can update rules in-place based on answers. Use when setting up rules for the first time, debugging rules that fire too often or never, or doing a periodic rules hygiene pass.

Overview

PublisherFlorianBruniaux
Repositoryclaude-code-ultimate-guide
Skill nameeval-rules
Stars
6K
Forks
782
Bundled files
Instructions only
LicenseCC-BY-SA-4.0
Links
  • Markdown instructions

    A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.

  • Works with any LLM

    AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.

  • Self-contained

    Everything the model needs lives in the instructions — no extra files to sync.

  • Open source

    Published by FlorianBruniaux on GitHub. Read the source before you install it.

Installation

Install the Eval Rules AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

1

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
  4. Enable the skill in any chat where you want it available.
Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.
2

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills
git clone --depth 1 https://github.com/FlorianBruniaux/claude-code-ultimate-guide.git /tmp/claude-code-ultimate-guide
mkdir -p .claude/skills
cp -r /tmp/claude-code-ultimate-guide/examples/skills/eval-rules .claude/skills/eval-rules
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Eval Rules in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Eval Rules on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Eval Rules is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

  • Loaded only when it is needed

    The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.

  • Switch models mid-chat

    Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

Rules Evaluator

Discover all rule files, validate their structure and glob patterns against the real project, then run an interactive session to confirm (or improve) each rule with the user.

The goal is not just to score; it is to leave the rules directory in better shape than it was.

When to Use

  • First time writing .claude/rules/ files (validate before committing)
  • A rule seems to never trigger, or fires on every file
  • Migrating @ imports from CLAUDE.md to path-scoped rules
  • Periodic hygiene: "are these rules still relevant to how we work?"
  • After onboarding to a new codebase

Key Concepts

MechanismWhen it loadsNotes
@file in CLAUDE.mdSession start, alwaysEven inside a conditional sentence
No paths: in ruleSession start, alwaysSame cost as @import
paths: frontmatterWhen Claude reads a matching fileTrigger = Read tool on a matched file
User-level rule (~/.claude/rules/)Session start, alwaysApplies to all projects on the machine

The paths: field is the main lever for keeping rules contextual. An always-on rule with 80 lines loads on every session even if you're fixing a typo in README.md.

Glob patterns in paths: support brace expansion: "src/**/*.{ts,tsx}" matches both .ts and .tsx files with one entry.


Scoring Criteria (12 pts per rule)

#CriterionMaxWhat is checked
1frontmatter block1File has YAML frontmatter (--- delimited)
2paths: field2Present (1pt) + at least one pattern listed (1pt)
3pattern validity3Each pattern matches >= 1 file in project (up to 3 patterns checked)
4scope2Not dead (>= 1 match) + not too broad (<30% of project source files)
5content quality3Has clear header/title (1pt) + rules are specific/actionable (1pt) + under 150 lines (1pt)
Bonusfocus+1Under 15 rules in file

Thresholds:

  • Good: >= 10/12 (>= 83%)
  • Needs work: 7-9/12 (58-82%)
  • Fix: < 7/12 (< 58%)

Always-on rules (no paths: field): skip criteria 2, 3, 4. Score on 5 pts max. Flag with a blue marker and go through the interactive step to decide if scoping is needed.


Execution Instructions

Step 1: Discovery

Use Glob to find all rule files:

.claude/rules/**/*.md

If an argument was passed (e.g., /eval-rules ./my-rules/), use that path instead.

Also scan ~/.claude/rules/ for user-level rules if the user asks for a full picture (these are always-on and apply to all projects on the machine).

Also count total source files for scope % calculation:

bash
find . \( -name "*.py" -o -name "*.ts" -o -name "*.tsx" -o -name "*.js" -o -name "*.go" -o -name "*.rs" \) \
  ! -path "*/node_modules/*" ! -path "*/.git/*" ! -path "*/dist/*" \
  2>/dev/null | wc -l

If no .claude/rules/ directory exists, report it and stop.

Step 2: Parse each rule

For each .md file found:

  1. Read the full file
  2. Extract YAML frontmatter (content between first --- and second ---)
  3. Parse paths: field: collect all glob patterns as a list
  4. Classify: conditional (has paths:), always-on (no frontmatter or no paths:), or user-level (from ~/.claude/rules/)
  5. Read the body: line count, presence of a clear title/header, whether rules are specific

Step 3: Resolve glob patterns

For each rule with paths:, use Glob to resolve each pattern against the project:

  • Collect total matched files per pattern
  • Show up to 10 sample paths
  • Flag dead patterns (0 matches) and broad patterns (>30% of source files)

Step 4: Interactive review (core of the skill)

Process rules one by one. Do not batch and skip the interaction.

For each conditional rule (has paths:):

Show:

Rule: payments.md [conditional]
paths: ["**/payments/**", "src/billing/**"]
Matches: 12 files
  - src/payments/stripe.py
  - src/payments/webhook.py
  - src/billing/invoice.py
  ... (9 more)

Ask three questions:

  1. "Is this scope right? (y = yes / n = needs adjustment)"
  2. "Is this rule still useful day-to-day? (y / n / unsure)"
  3. "Anything to add, remove, or update in the rule content? (describe or skip)"

For each always-on rule (no paths:):

Show:

Rule: database.md [always-on, loads every session]
Content: 91 lines, 8 rules

Ask:

  1. "This rule loads at every session. Should it stay always-on, or be scoped to specific files? (keep / scope / skip)"
  2. "Is the content still accurate and useful? (y / n)"

If the user says scope: help them define a paths: pattern based on the rule content (e.g., database rules -> **/models/**, **/migrations/**, **/*.sql). Propose the frontmatter block and ask for confirmation before editing.

If the user provides corrections or updates during the interaction: apply them directly using Edit, confirm each change, then move to the next rule.

Step 5: Output report

After all rules are reviewed:

# Rules Audit: [project name or path]
Date: [today] | Scanned: N rules (X conditional, Y always-on)

## Summary

| Status | Count |
|--------|-------|
| Good (>= 83%) | N |
| Needs work (58-82%) | N |
| Fix (< 58%) | N |
| Always-on (no paths:) | N |
| User confirmed useful | N |
| User flagged for update | N |
| User marked as stale | N |

---

## Per-Rule Results

### payments.md (11/12) [conditional]

paths: `**/payments/**`, `src/billing/**`
Matches: 12 files (3.5% of 340 source files)

| Criterion | Score | Notes |
|-----------|-------|-------|
| frontmatter | 1/1 | ok |
| paths: field | 2/2 | 2 patterns |
| pattern validity | 3/3 | All match >= 1 file |
| scope | 2/2 | 3.5%, well-scoped |
| content quality | 2/3 | 158 lines (over 150) |

User feedback: scope confirmed ("fires exactly when we work on Stripe")
Content: no changes needed

---

### database.md (3/5) [always-on]

No paths: field; loads at every session.

| Criterion | Score | Notes |
|-----------|-------|-------|
| frontmatter | 0/1 | No frontmatter block |
| content quality | 3/3 | 91 lines, specific rules, clear header |
| focus | 1/1 | 8 rules |

User feedback: scope -> added paths: ["**/models/**", "**/migrations/**", "**/*.sql"]
Edit applied

---

Step 6: Fix Summary

## What Changed This Session

database.md:
  - Added frontmatter with paths: ["**/models/**", "**/migrations/**", "**/*.sql"]

testing.md:
  - User confirmed useful, no changes

git-workflow.md:
  - User flagged as stale (marked for deletion, not deleted yet, awaiting confirmation)

---
N rules audited / N edits applied / N rules flagged as stale

For any rule the user marked as stale or outdated: ask for explicit confirmation before deleting. Never delete without a clear "yes, delete it".


Edge Cases

  • Subdirectory rules (e.g., .claude/rules/frontend/react.md): discovered and processed normally
  • Symlinked files or directories in .claude/rules/: supported by design, discovered and processed normally
  • Invalid YAML frontmatter: report parse error, score frontmatter as 0/1
  • Empty file: flag as broken, skip interactive step, ask if it should be deleted
  • Dead pattern (0 matches): flag, suggest fix based on rule content
  • Pattern matching >30% of files: flag as too broad, suggest narrowing
  • User says "unsure" about usefulness: note it in the report, do not edit, add a comment "Review in next audit"
  • Rules not loading as expected: advise the user to add the InstructionsLoaded hook, which logs exactly which rule files load and when

Frequently asked questions

What does the Eval Rules AI skill do?

Audit .claude/rules/ files for structural correctness, glob validity, and real-world usefulness. Resolves each paths: pattern against actual project files, then asks the user whether each rule is still relevant and useful. Can update rules in-place based on answers. Use when setting up rules for the first time, debugging rules that fire too often or never, or doing a periodic rules hygiene pass.

Why use Eval Rules on TypingMind?

Because you install it once and use it with any model. Eval Rules is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Eval Rules in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/FlorianBruniaux/claude-code-ultimate-guide/tree/main/examples/skills/eval-rules. TypingMind reads its SKILL.md and installs it as a skill you can enable per chat.

Which AI models can use Eval Rules?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Eval Rules?

As many as you like. As long as a model supports skills, you can use Eval Rules with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Eval Rules AI skill free?

Yes. It is published on GitHub by FlorianBruniaux under the CC-BY-SA-4.0 license. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇