validate-links

Validate Markdown cross-links and schema-requirement back-links in the CLI Agent Spec.

5|Updated Mar 14, 2026
One-click install
npx skills add https://github.com/cli-agent-spec/cli-agent-spec --skill validate-links-cli-agent-spec
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: validate-links
Source: https://github.com/cli-agent-spec/cli-agent-spec/tree/main/.claude/skills/validate-links
Command: npx skills add https://github.com/cli-agent-spec/cli-agent-spec --skill validate-links-cli-agent-spec

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill prevents broken and inconsistent cross-references inside the CLI Agent Spec by validating that links, schema↔requirement relationships, and index listings all match what’s on disk.

Core Features & Use Cases

  • Broken link detection: Finds broken relative links across all Markdown files, excluding external links.
  • Schema ↔ requirement symmetry checks: Ensures requirements that “Used by” a schema link back correctly via the requirement’s Schema section, and vice versa.
  • Index completeness enforcement: Verifies requirements/index.md and schemas/index.md both (a) list existing files and (b) include every file present in their directories.
  • Content completeness reporting: Reports which challenge and requirement files are missing required sections to guide ongoing authoring.
  • Counter consistency verification: Detects mismatches between declared counts in prose files (README/CLAUDE and indexes) and the actual file counts.

Quick Start

Ask the validate-links skill to validate all cross-links in the CLI Agent Spec after you add or edit Markdown, schemas, or requirements to ensure the repository stays internally consistent.

Frequently Asked Questions about validate-links

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

FAQPage Schema
How do I check for broken Markdown links in a repository?

To check for broken Markdown links in a repository, you can validate cross-link integrity by scanning relative link targets across all Markdown files. This process detects broken relative links while excluding external links, ensuring documentation stays internally consistent.

How do I verify schema and requirement bidirectional symmetry in documentation?

Verifying schema and requirement bidirectional symmetry involves checking that requirements listing a schema under 'Used by' correctly link back via the requirement's Schema section. This ensures bidirectional symmetry constraints are satisfied across all spec files.

What is the best way to enforce index completeness for Markdown documentation?

The best way to enforce index completeness for Markdown documentation is to validate that index files like requirements/index.md and schemas/index.md list all existing files and include every file present in their respective directories, enforcing index inclusion rules.

Why does my requirements index show a different file count than the actual directory?

Your requirements index shows a different file count than the actual directory due to a counter consistency mismatch between declared counts in prose files and actual file counts. Running a counter consistency verification detects these mismatches between README or index declarations and on-disk reality.

When should I run link validation in a repository maintenance workflow?

You should run link validation in a repository maintenance workflow after editing spec files, adding schemas or requirements, or restructuring documentation. This ensures link existence verification, bidirectional symmetry, and index completeness are maintained after content changes.

Can I detect missing required sections in challenge and requirement files?

Yes, you can detect missing required sections in challenge and requirement files through content completeness reporting. This reports which specific files are missing required sections, guiding ongoing authoring and ensuring required section coverage across the CLI Agent Spec.