broken-refs

Validate file references in SKILL.md skills and report missing paths.

9|1|Updated Feb 10, 2026
One-click install
npx skills add https://github.com/skill-tools/skill-tools --skill broken-refs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: broken-refs
Source: https://github.com/skill-tools/skill-tools/tree/main/packages/core/test/fixtures/broken-refs
Command: npx skills add https://github.com/skill-tools/skill-tools --skill broken-refs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Detect and resolve missing or mislinked references in SKILL.md skills to prevent runtime failures and documentation breakage.

Core Features & Use Cases

  • Validate the existence of files referenced in SKILL.md bodies and linked sections.
  • Report broken links to scripts/, references/, and assets/ directories with actionable remediation steps.
  • Integrate into CI to catch broken references before deployment.

Quick Start

Run the validator on the broken-refs directory to identify missing references and generate a remediation plan.

Frequently Asked Questions about broken-refs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I find broken file references in SKILL.md documents?

You can find broken file references in SKILL.md documents by running a validator that parses YAML frontmatter, resolves relative paths, and reports missing files with actionable remediation steps.

What causes broken links to scripts and assets in local repositories?

Broken links to scripts and assets occur when SKILL.md files reference paths that have been moved, renamed, or deleted, causing runtime failures and documentation breakage in local repositories and CI pipelines.

Can I validate missing references in a CI pipeline before deployment?

Yes, you can validate missing references in a CI pipeline before deployment by integrating the validator to automatically catch broken links to scripts, references, and assets directories.

How do I resolve mislinked references in skill documentation?

To resolve mislinked references in skill documentation, run the validator on your skill directory to identify missing files and generate a remediation plan that provides actionable steps to repair the links.

Does the broken reference validator check YAML frontmatter and relative paths?

Yes, the broken reference validator parses YAML frontmatter to extract linked paths and resolves relative file paths to validate the existence of referenced files in scripts, references, and assets directories.