openapi-spec-generation

Generate and maintain OpenAPI 3.1 specifications from code, design-first specs, and validation patterns. Use when creating API documentation, generating SDKs, or ensuring API contract compliance.

Quality

69%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

Securityby

Passed

No findings from the security scan

Fix and improve this skill with Tessl

tessl review fix ./plugins/documentation-generation/skills/openapi-spec-generation/SKILL.md

Quality

Content

51%Weight 40%Scale 1-5

Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.

The body is a concise, well-organized overview but functions more as a conceptual reference than an actionable guide: inline code is placeholder pseudocode, there is no sequenced workflow with validation checkpoints, and one of the two bundle reference files is not linked from the body.

Suggestions

Add a concrete, executable OpenAPI snippet (a complete path operation with responses and a $ref) so the body stands on its own instead of relying on details.md for copy-paste-ready templates.

Include a short numbered workflow for spec generation/validation with an explicit validation checkpoint (e.g., lint with a validator, fix errors, re-validate before publishing).

Link references/code-first-and-tooling.md from the body — e.g., a "Code-first generation" line under the Templates section — so both bundle files are discoverable.

Dimension	Reasoning	Score
Conciseness	Mostly lean with terse best-practice bullets and a compact design-approaches table that assume Claude's familiarity with OpenAPI; the redundant opening line "Comprehensive patterns for creating, maintaining, and validating..." and the placeholder-laden YAML skeleton ("get: ...", "schemas: ...") could be trimmed, keeping it just below fully efficient.	4 / 5
Actionability	The inline YAML skeleton is incomplete/pseudocode (placeholders like "get: ..."), and the Do's/Don'ts are directive advice rather than executable commands; concrete, copy-paste-ready templates are offloaded to references/details.md, leaving the body's guidance incomplete on its own.	3 / 5
Workflow Clarity	The body is organized as concepts and best practices rather than a sequenced process, with no step ordering and no validation/verification checkpoint for the spec-generation/validation tasks it covers.	2 / 5
Progressive Disclosure	Sections are reasonably organized and templates are offloaded to references/details.md, but references/code-first-and-tooling.md is a bundle file that is never linked or signaled from the body, leaving one reference un-navigable.	3 / 5
	Total	12 / 20 Passed

Description

87%Weight 40%Scale 1-5

Based on the skill's description, can an agent find and select it at the right time? Clear, specific descriptions lead to better discovery.

A strong description that explicitly states both capabilities and trigger conditions with concrete, natural-language terms. Minor gaps in action specificity and synonym/extension coverage prevent a perfect score on two dimensions.

Dimension	Reasoning	Score
Specificity	Lists several concrete actions — "Generate and maintain OpenAPI 3.1 specifications from code, design-first specs, and validation patterns" — with only minor gaps; "validation patterns" is somewhat abstract as an action source, keeping it just below comprehensive.	4 / 5
Completeness	Clearly answers both what ("Generate and maintain OpenAPI 3.1 specifications from code, design-first specs, and validation patterns") and when ("Use when creating API documentation, generating SDKs, or ensuring API contract compliance") with concrete trigger phrases.	5 / 5
Trigger Term Quality	Good coverage of natural terms users would say ("API documentation", "SDKs", "API contract compliance", "OpenAPI"), but file extensions like .yaml/.json and synonyms like "Swagger" are missing.	4 / 5
Distinctiveness Conflict Risk	Targets a clear niche (OpenAPI 3.1 spec generation/maintenance) with distinct, specific triggers; minimal overlap risk with unrelated skills.	5 / 5
	Total	18 / 20 Passed

Validation

100%

Warnings & errors only

Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.

Validation — 16 / 16 Passed

Validation for skill structure

No warnings or errors.

Repository: wshobson/agents
Path: plugins/documentation-generation/skills/openapi-spec-generation/SKILL.md
Commit: d6837ae

Reviewed: about 12 hours ago

Table of Contents

Discovery Implementation Validation

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.