explaingit

xiaoshi-11111111/codex-skill-auditor

14PythonAudience · developerComplexity · 2/5Setup · easy

TLDR

A command-line tool that audits AI agent skill folders for structural problems and trigger-quality issues before you publish or share them, with CI and pre-commit hook support.

Mindmap

mindmap
  root((repo))
    What it does
      Structural checks
      Trigger quality checks
      Overlap detection
      Autofix support
    Tech stack
      Python
      YAML parsing
      GitHub Actions
      Pre-commit hook
    Use cases
      CI skill gating
      Pre-publish review
      Batch folder audit
    Audience
      AI tool builders
      Prompt engineers
      Dev teams
Click or tap to explore — scroll the page freely

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

Things people build with this

USE CASE 1

Catch missing files, bad YAML, or placeholder text in an AI skill folder before publishing it.

USE CASE 2

Block a pull request in CI if a skill's trigger description is written in a way that confuses agents.

USE CASE 3

Scan an entire directory of skills at once to find descriptions that overlap and could cause the wrong skill to fire.

USE CASE 4

Run as a pre-commit hook so skill quality issues are caught locally before they reach code review.

Tech stack

PythonYAMLGitHub Actionspre-commitCLI

Getting it running

Difficulty · easy Time to first run · 5min

Installable as a Python package via pip. Also available as a GitHub Action or pre-commit hook. No external services required.

License not mentioned in the explanation.

In plain English

This repository provides a command-line tool for checking AI agent skill folders before publishing or sharing them. Skills for AI coding assistants like OpenAI Codex or Anthropic Claude are organized as folders containing a description file, configuration files, and optional scripts. The auditor scans these folders and reports problems that are easy to miss during manual review. The checks cover two broad areas. Structural checks catch things like missing required files, invalid YAML formatting, placeholder text that was never replaced, files that are too large, broken internal links, and Python syntax errors in bundled scripts. Trigger quality checks, added in version 0.3, focus on the description field that an agent reads to decide whether to load and follow a skill. The key finding the tool is built around is that if a description summarizes what the skill does rather than stating when it should be activated, agents tend to follow the description instead of reading the full skill instructions. The auditor flags descriptions written in first-person, descriptions that summarize workflow steps, and descriptions that exceed character budget limits. The tool outputs color-coded results in the terminal and switches to plain Markdown automatically when run in a CI environment like GitHub Actions. A strict mode causes the command to exit with a failure code even for lower-severity findings, which is useful for blocking a pull request if a skill has quality issues. An autofix flag handles mechanical corrections automatically, such as renaming a skill to match its folder name or moving documentation files outside the skill folder. Judgment calls like rewriting a description are left to the person reviewing the output. The tool can also audit an entire directory of skills at once and detect when two skills have descriptions that overlap too closely, which can cause agents to trigger the wrong one. It is installable as a Python package, a GitHub Action, or a pre-commit hook. A future planned feature would drive a small language model against a scenario file to test whether a skill actually triggers correctly.

Copy-paste prompts

Prompt 1
I have a skill folder for OpenAI Codex with a description file and some YAML config. Using codex-skill-auditor, what command do I run to check it for structural issues and get a color-coded report?
Prompt 2
My AI skill keeps triggering when it shouldn't. Using codex-skill-auditor's trigger quality checks, how do I find out if my description field is written in first-person or summarises steps instead of stating when to activate?
Prompt 3
I want to add codex-skill-auditor to my GitHub Actions workflow so that any pull request with skill quality issues is automatically blocked. Show me a minimal workflow YAML to do that using strict mode.
Prompt 4
I have a directory with 20 skill folders and I want to detect any two skills whose descriptions overlap too closely. What codex-skill-auditor command handles batch auditing and overlap detection?
Prompt 5
I installed codex-skill-auditor and ran it with --autofix. What kinds of fixes does it apply automatically, and what does it leave for me to fix manually?
Open on GitHub → Explain another repo

← xiaoshi-11111111 on gitmyhub — every repo by this author, as a profile.

Verify against the repo before relying on details.