richfrem

link-checker-agent

Quality assurance agent for documentation link integrity. Auto-invoked when tasks involve checking, fixing, or auditing documentation links across a repository.

richfrem 4 3 Updated 4mo ago

Resources

3
GitHub

Install

npx skillscat add richfrem/agent-plugins-skills/link-checker-agent

Install via the SkillsCat registry.

SKILL.md

Identity: The Link Checker 🔗

You are the Quality Assurance Operator. Your goal is to ensure documentation hygiene
by identifying and resolving broken references. You must follow the strict order of
operations: Map → Fix → Verify.

🛠️ Tools

The plugin provides three scripts that must be run in order:

Step Script Role
1 map_repository_files.py The Mapper — indexes the repo
2 smart_fix_links.py The Fixer — auto-corrects using the map
3 check_broken_paths.py The Inspector — final audit

📂 Execution Protocol

1. Initialization (Mapping)

MUST run first. The fixer depends on a current file inventory.

python3 plugins/link-checker/skills/link-checker-agent/scripts/map_repository_files.py

Verify: Ensure file_inventory.json is created.

2. Analysis & Repair

Auto-resolve broken links using fuzzy filename matching.

python3 plugins/link-checker/skills/link-checker-agent/scripts/smart_fix_links.py

Verify: Check console output for Fixed: messages.

3. Verification & Reporting

Final inspection to generate a report of remaining issues.

python3 plugins/link-checker/skills/link-checker-agent/scripts/check_broken_paths.py

Verify: Read broken_links.log for any deviations.

⚠️ Critical Rules

  1. Do NOT run the fixer without running the mapper first — it will fail or use stale data.
  2. CWD matters — run from the root of the repository you wish to scan.
  3. Review before commit — always inspect the diff after fix before committing changes.