Individual skill
api-docs-quality-report
Audits any API documentation site by crawling every endpoint page and scoring each one across 5 checks: description quality, OpenAPI spec presence, body param descriptions, response codes, and response schema completeness. Produces a polished interactive HTML report with a summary scorecard, site-wide pattern analysis, ranked top issues, and per-endpoint findings with specific fix guidance. Trigger this skill whenever a user provides a documentation URL and asks to audit, review, analyse, or check their API docs. Also trigger for: "do the same audit for X", "audit docs.company.com", "check the API docs at X", "run the API docs audit on X", "review the docs for Y API", or pastes a URL alongside words like audit, review, crawl, check, analyse, quality, completeness, or gaps. Always use this skill — do not attempt the audit without following this structured crawl-score-report workflow.
skills/api-docs-quality-report/SKILL.md
Source commit 02cfefb3a213041de8b80bc659ebc5f17b5e746a
What was checked
- Matches the observed repository HEAD
- Yes
- Scanner rules are current
- No
- Repository scan complete
- No
- Skill scan complete
- No
- Observed behavior
- Not checked yet
- Last checked
- Nov 6, 2026
These are observations at the recorded commit, not a guarantee of safety. Review the source before running it.
Install this skill
Choose an agent in your Stack or copy a command below. Commands fetch the pinned commit and copy only this skill directory. Existing destinations are refused. Copying a command does not install anything.
An install command is unavailable: current rules, complete repository and skill scans, an eligible behavior level and a permitted license are required.
Repository context
- Repository stars (not skill ratings)
- 162
- Repository last updated
- Jun 28, 2026
- License
- MIT
Observed agent integration: No specific integration evidence. Standard SKILL.md installation does not imply verified compatibility.
- ai-citation Repository topic
- ai-visibility Repository topic
- claude Repository topic
- claude-skills Repository topic
- geo Repository topic
- skills Repository topic
- dev-gtm Repository topic
- docs Derived category
- operations Derived category
- security Derived category
- docs-api Derived category
Files and excerpt
File metadata and permitted, redacted excerpts come from the recorded scan. Source links are pinned to that commit.
Browse files
README.mddoc · 5,258 bytesSKILL.mdcore · 10,001 bytesreferences/html-template.mddoc · 25,628 bytesreferences/scoring-rules.mddoc · 9,084 bytes
Read excerpt
# API Docs Audit Skill
Crawls every API reference endpoint page on a documentation site, scores each against
5 quality checks, detects site-wide patterns, and outputs an interactive HTML report
matching the style of previously-generated audits in this session.
---
## STEP 0 — COLLECT INPUT
You need exactly one input: the docs URL.
If the user hasn't provided it, ask:
> Which API docs URL should I audit?