Guide · Agent skill
How to use the Consistency Check for Game Design Docs skill
Updated · written with AI from the project's own documentation and checked against our catalogue data
The consistency-check skill is an agent skill for Claude Code that compares your game design documents against a registry of game entities such as characters, items, formulas and constants. It looks for places where one document states a value, such as a price or weight, that disagrees with the registry. This guide explains what the skill makes the agent do, how to install it, how to run it with plain requests, and what it needs to work.
Consistency Check for Game Design DocsDonchitos/Claude-Code-Game-Studios · MIT Download the skill Quick start
- 1Download the ZIP. Get the consistency-check ZIP from the skill page on this site.
- 2Unzip into a skills folder. Unzip into ~/.claude/skills/ for all projects, or into the project's .claude/skills/ folder for one project.
- 3Confirm the registry exists. Check that design/registry/entities.yaml is present and has entries. The skill will not compare anything without them.
- 4Confirm the helper scripts are present. Make sure hooks/yaml-helper.sh and .claude/scripts/registry.sh from the parent repository are in place, and that Bash and git are available.
- 5Run the check. Type /consistency-check, or add full, since-last-review, entity:<name> or item:<name> to narrow the scope.
- 6Review and resolve conflicts. Open each conflict, compare the registry value with the GDD text, then correct whichever one is wrong before building on it.
What the consistency-check skill does
An agent skill is a folder with a SKILL.md file that tells an AI agent how to carry out a specific task in your project. This one turns the agent into a cross-checker for a game design project. It reads the entity registry at design/registry/entities.yaml once, then searches the design documents in design/gdd/ for every registered name.
The search is grep-first. The agent pulls out only the matching lines and a few lines of context around each hit, rather than reading every document in full. When a stated value conflicts with the registry, it is flagged. If a document mentions a registered name but gives no value for an attribute, the skill records a note saying that value could not be verified.
The skill produces a conflict report and can propose or make registry corrections. It is designed to run after design documents are written and before other review steps, such as the /review-all-gdds skill or /create-architecture.
- Entities: compares attributes such as counts, costs, durations and categories
- Items: compares values such as sell price, weight, stack rules and category
- Formulas: compares variable names and output ranges
- Constants: compares numeric values
Install the consistency-check skill
Download the ZIP from the skill page on this site. The package contains SKILL.md. Then choose one of two install locations. For all your projects, unzip it into ~/.claude/skills/. For a single project, unzip it into that project's .claude/skills/ folder.
If you use the Claude apps instead of Claude Code, open Settings, go to Capabilities, then Skills, and upload the ZIP there.
- Personal install: ~/.claude/skills/ (available across projects)
- Project install: .claude/skills/ inside the project folder (shared with anyone who uses that repository)
- Claude apps: Settings → Capabilities → Skills, then upload the ZIP
Set up the files the skill depends on
The skill is built for the Claude Code Game Studios template, and it expects a particular project layout. Without the registry file it cannot compare anything. The skill's helper scripts also need to be present in the parent repository.
The skill calls hooks/yaml-helper.sh to resolve configuration and .claude/scripts/registry.sh to validate the registry. Both are listed in its allowed tools. It also runs git log to detect which design documents changed.
- design/registry/entities.yaml must exist and contain entries
- design/gdd/ should hold your system GDDs as .md files
- hooks/yaml-helper.sh and .claude/scripts/registry.sh must come from the parent repository
- Bash and git must be available on the machine
git log --name-only --pretty=format: -- design/gdd/Run the skill with a command or a plain request
Invoke the skill with /consistency-check. With no argument it checks every registered entry against every GDD. You can narrow the scope with one of four modes: full, since-last-review, entity:<name> or item:<name>.
You can also ask in plain language, for example asking the agent to check the design documents for conflicting numbers or to check the prices of one item across the GDDs. Use the named modes when you want a predictable scope.
- Check everything: /consistency-check full
- Check only documents changed since the last review: /consistency-check since-last-review
- Check one entity across all GDDs: /consistency-check entity:[name]
- Check one item across all GDDs: /consistency-check item:[name]
/consistency-check entity:[name]Read the report and act on it
The report starts by stating how many entities, items, formulas and constants were loaded from the registry, and which scope was used. Each conflict names the registry value, the value found in the GDD, and the document. Notes mark values that could not be verified.
Some outcomes stop the check early instead of producing a PASS. If the registry is empty, the verdict is NOT ASSESSED because nothing was compared. The same applies when no GDDs are in scope, or when you name an entity or item that is not in the registry. Depending on your automation settings, the skill may ask you before it changes anything in the registry.
- Conflict: the registry and a GDD give different values for the same name
- Note: a GDD mentions a registered name without giving the attribute
- NOT ASSESSED: registry empty, no GDDs in scope, or the named entity is missing
- Registry corrections are proposed or applied according to your automation mode
What people use it for
- Catching a sell price that differs between an item's registry entry and the economy GDD before balancing begins
- Checking one entity such as a character's stats across every system document after an edit
- Running the check after writing each new GDD, so inconsistencies do not reach the architecture stage
- Confirming that a formula's variable names and output range match wherever the formula is described
Frequently asked questions
How do I install the consistency-check skill?
Download the ZIP from the skill page and unzip it into ~/.claude/skills/ for all projects, or into the project's .claude/skills/ folder for one project. In the Claude apps, upload the ZIP under Settings, then Capabilities, then Skills.
What does the consistency-check skill require?
It requires Claude Code or a compatible agent with access to your project files, a populated design/registry/entities.yaml file, and Bash and git available. It also needs the hooks/yaml-helper.sh and .claude/scripts/registry.sh scripts from the parent repository.
Is the consistency-check skill free?
The skill is published under the MIT licence, according to the source listing. This page does not cover pricing for Claude Code or the Claude apps.
Why does the skill say NOT ASSESSED?
It means nothing was compared, so the result is not a pass. This happens when the registry is empty or missing, when no GDDs are in scope, or when the entity or item you named is not in the registry.
Does the skill use the internet?
The source lists network use as no. It runs local scripts and reads and searches your project files with Bash, Glob, Grep and Read, and git is used to detect changed documents.
Can grep-based checking miss conflicts?
Yes. The skill compares names and values, and it can miss conflicts described in different wording. It is not a full logical review of design quality, so it works best alongside your own reading.
New agent skills, repos and AI tools — every week
The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.
Our verdict
Use consistency-check if you run a game project on the Claude Code Game Studios setup, keep many design documents, and want to catch contradictory numbers across them before building. Pick something else if you have no entity registry, or if you need a review of design quality rather than a name-and-value comparison.
Download the skill