validate-config
Skill4 starsChanged 5 months agoMITView on GitHub
Validate a project configuration file against the team's structural requirements and naming/range conventions, then write a CONFIG_REPORT.md listing every violation.
In this repository5 other files it gives its agents.
- AGENTS.mdAGENTS.md
- commit-push-prSkill
- fix-failing-testsSkill
- review-diffSkill
- write-release-notesSkill
The file
Show its rules and text
We split this skill into the rules it gives an agent
13 rules. About 0 are common, 8 are distinctive, and 5 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈8
Distinctive · estimate
This author's own choices. Worth a look.
5
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 14
Structural pass: run the bundled validation script, which checks required keys and value types.
- Very specific: line 15
Convention pass: check every value against the team's convention rules, which are documented in this skill's references/config-rules.md.
- Distinctive: line 21
Use when the user asks to validate, audit, lint, or check a configuration file, or asks whether a config follows team conventions or policy.
- Distinctive: line 29
Do NOT guess the team's conventions — they are arbitrary house rules you cannot infer.
- Very specific: line 31
Run the bundled script scripts/validate_config.py (located in this skill's directory) for the structural pass.
- Very specific: line 32
Read references/config-rules.md (located in this skill's directory) for the convention pass.
- Very specific: line 50
Read references/config-rules.md from this skill's directory.
- Distinctive: line 54
Read the config file and evaluate each rule from the reference document against the actual values.
- Very specific: line 58
Create CONFIG_REPORT.md in the workspace root with this structure:
- Distinctive: line 81
All of these must be true:
- Distinctive: line 89
If the config file does not exist, report which file was expected and stop
- Distinctive: line 90
If the config is not valid JSON, report the parse error as a structural issue and skip the convention pass
- Distinctive: line 91
If the bundled script cannot be found, say so explicitly — do not silently substitute your own checks
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
What I do
Validate a JSON configuration file (e.g. app_config.json) in two passes:
- Structural pass: run the bundled validation script, which checks required keys and value types.
- Convention pass: check every value against the team's convention rules, which are documented in this skill's
references/config-rules.md.
Then write a CONFIG_REPORT.md in the workspace root listing every violation found, and summarize the result to the user.
When to use me
Use when the user asks to validate, audit, lint, or check a configuration file, or asks whether a config follows team conventions or policy. Trigger on phrases like:
- "validate the config"
- "check app_config.json against our conventions"
- "does this config follow our policy?"
- "audit the configuration file"
IMPORTANT: Use the bundled resources
Do NOT guess the team's conventions — they are arbitrary house rules you cannot infer. You MUST:
- Run the bundled script
scripts/validate_config.py(located in this skill's directory) for the structural pass. Do not re-implement its checks by hand. - Read
references/config-rules.md(located in this skill's directory) for the convention pass. Every rule in that file must be checked.
Steps
Step 1: Run the structural validator
The script lives in this skill's directory, next to this SKILL.md file. Run it with the config file as the argument:
python <path-to-this-skill>/scripts/validate_config.py app_config.json(Use python3 if python is not on the PATH.)
It prints one STRUCTURAL: ... line per problem, or STRUCTURAL: OK if the structure is valid.
Step 2: Read the convention rules
Read references/config-rules.md from this skill's directory. It defines numbered rules (RULE 1, RULE 2, ...) for naming, ranges, and allowed values.
Step 3: Check the config against every rule
Read the config file and evaluate each rule from the reference document against the actual values. Record each violation with its rule number.
Step 4: Write CONFIG_REPORT.md
Create CONFIG_REPORT.md in the workspace root with this structure:
# Config validation report: <config file name>
## Structural issues
- <each STRUCTURAL line from the script, or "None">
## Convention violations
- RULE <n>: <key> = <actual value> — <what the rule requires>
- ...or "None"
TOTAL VIOLATIONS: <count of structural issues + convention violations>Step 5: Report to the user
Summarize the findings in your reply and include the exact TOTAL VIOLATIONS: <n> line in your final message.
Definition of done
All of these must be true:
- The bundled
validate_config.pyscript was executed (not re-implemented) references/config-rules.mdwas read and every rule in it was checkedCONFIG_REPORT.mdexists in the workspace root with both sections and theTOTAL VIOLATIONS:line- The final reply to the user contains the
TOTAL VIOLATIONS: <n>line
Error handling
- If the config file does not exist, report which file was expected and stop
- If the config is not valid JSON, report the parse error as a structural issue and skip the convention pass
- If the bundled script cannot be found, say so explicitly — do not silently substitute your own checks
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

