agentdev-artifact-validation

Validates frontmatter ID consistency, README entry existence, and change scope via deterministic TypeScript scripts.

Updated Mar 7, 2026
One-click install
npx skills add https://github.com/yogata/agent-dev-flow --skill agentdev-artifact-validation-yogata
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: agentdev-artifact-validation
Source: https://github.com/yogata/agent-dev-flow/tree/main/src/opencode/skills/agentdev-artifact-validation
Command: npx skills add https://github.com/yogata/agent-dev-flow --skill agentdev-artifact-validation-yogata

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires typescript, @types/bun, and includes scripts (resource) components.

What problem does it solve? Manual verification of document metadata—such as checking that a REQ or Decision file's frontmatter ID matches its filename, confirming an ID appears in a README index, or ensuring edits stay within an allowed path scope—is error-prone when done by LLM reasoning alone. This Skill replaces that judgment with deterministic, testable scripts that return structured JSON results. ## Core Features & Use Cases - Frontmatter Consistency Check: Verifies that frontmatter id values match filenames for REQ-NNNN, ADR-NNNN, and DEC-NNN Markdown files in a directory. - Entry Existence Check: Confirms a given ID (e.g., REQ-0001) appears in one or more README index files. - Change Impact Validation: Compares a list of changed file paths against an allowed path prefix list and reports violations outside the permitted scope. - Use Case: During a case-ready workflow, run the change-impact script against the set of edited files and the allowed path list to mechanically prove no out-of-scope files were modified before saving a Definition package. ## Quick Start Ask the agent to run the artifact-validation scripts to verify that all requirement files in docs/requirements have frontmatter IDs matching their filenames and report the JSON result.

Frequently Asked Questions about agentdev-artifact-validation

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

FAQPage Schema
How do I check frontmatter ID consistency across Markdown files?▼

Run check-frontmatter-consistency.ts with a directory path and a kind argument (req, adr, or decision). It scans REQ-NNNN, ADR-NNNN, or DEC-NNN files and outputs JSON listing any files whose frontmatter id does not match the filename number.

How to verify a requirement ID exists in a README index?▼

Use check-entry-existence.ts with the ID as the first argument followed by one or more index file paths, or pipe JSON like { id, files } via stdin. It returns a JSON result with a found array listing files containing the ID.

How do I validate changed files against an allowed path scope?▼

Run check-change-impact.ts with a file listing changed paths and a file listing allowed path prefixes, or pass both arrays as stdin JSON. It supports glob-style prefixes like docs/requirements/** and reports violations for any path outside the allowed set.

Does this validation skill modify or write any files?▼

No. All scripts are pure functions with file I/O limited to reading inputs only. They write results to stdout as JSON and never perform writes, network calls, or other side effects.

What runtime is required to run these verification scripts?▼

The scripts are TypeScript executed via Bun, for example bun src/check-frontmatter-consistency.ts docs/requirements req. Tests run with bun test and type checking with tsc --noEmit.

When should I not use these validation scripts?▼

Do not use them for content judgment, document editing, ID number allocation, or target_area searches—those belong to the req, decision, and design file-manager skills. These scripts only perform deterministic mechanical verification.