CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

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.

58

Quality

73%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide
SecuritybySnyk

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
SKILL.md
Quality
Evals
Security

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, readable overview that correctly pushes bulk templates into reference files, but it lacks any sequenced workflow, its only inline code is a placeholder skeleton, and one of the two reference files is hidden a second level deep. Adding an explicit multi-step process (including validation commands) and surfacing code-first-and-tooling.md directly would address the weakest dimensions.

Suggestions

Add a short numbered workflow (e.g., pick approach → author/generate spec → validate with Spectral/Redocly → generate SDK/docs) so the multi-step process and its validation checkpoints are visible in SKILL.md, lifting workflow_clarity.

Link references/code-first-and-tooling.md directly in the body (e.g., in the templates section) instead of only via details.md, so SDK generation and validation tooling mentioned in 'When to Use This Skill' are one level deep.

Replace the ellipsis skeleton in 'Core Concepts' with one small but complete, copy-paste-ready example (or fold it into details.md) and trim structure Claude already knows, improving both actionability and conciseness.

DimensionReasoningScore

Conciseness

The body is lean — a short 'When to Use' list, a compact table, and terse do's/don'ts bullets. The 'Core Concepts' skeleton ('openapi: 3.1.0 ... paths: /resources: get: ...') restates standard OpenAPI structure Claude already knows, a minor instance of over-explanation that could be trimmed, matching the 'efficient; minor instances' anchor rather than the fully lean anchor above.

4 / 5

Actionability

The only code artifact is a skeleton with ellipsis placeholders ('get: ...', 'schemas: ...'), i.e., pseudocode rather than executable content, and the do's/don'ts are directives without commands. Deferring templates to references/details.md is legitimate, but the body itself leaves key specifics (how to run validation, how to generate a spec) unstated, matching the 'some concrete guidance but incomplete; pseudocode instead of executable code' anchor. It is not a 2 because the guidance is specific and clearly pointed at where the executable templates live.

3 / 5

Workflow Clarity

There is no sequenced process anywhere in the body, despite the task being genuinely multi-step (choose design-first vs code-first, author/generate the spec, validate with Spectral/Redocly, generate SDKs) — the validation and SDK-generation tooling exists only in the buried references/code-first-and-tooling.md. This matches 'rough sequence present but many gaps' at best; it is not a 1 because the sections are coherent and the pointer to details.md gives an implicit starting direction.

2 / 5

Progressive Disclosure

The SKILL.md → references/details.md pointer is clearly signaled with its own section, but references/code-first-and-tooling.md is only reachable through details.md (two levels deep) and is never mentioned in the overview — so content advertised in 'When to Use This Skill' (SDK generation, validation, docs portals) is hard to discover. This fits 'could be better organized' rather than the 'minor organization gaps' of a 4.

3 / 5

Total

12

/

20

Passed

Description

83%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: third-person voice, concrete capabilities, an explicit 'Use when...' clause with natural trigger phrases, and a well-defined OpenAPI niche. The only improvements are adding common synonyms (Swagger, REST API) and slightly broadening the action verbs.

DimensionReasoningScore

Specificity

The description names the domain and several concrete actions with explicit input modalities: 'Generate and maintain OpenAPI 3.1 specifications from code, design-first specs, and validation patterns.' It lists several specific capabilities but stops short of comprehensive coverage, matching the 'minor gaps' anchor rather than the 1-2-action anchor below or the fully comprehensive anchor above.

4 / 5

Completeness

It explicitly answers both questions: the 'what' is 'Generate and maintain OpenAPI 3.1 specifications from code, design-first specs, and validation patterns' and the 'when' is an explicit 'Use when creating API documentation, generating SDKs, or ensuring API contract compliance.' This matches the anchor for clearly and explicitly answering both with concrete trigger phrases.

5 / 5

Trigger Term Quality

Natural trigger phrases users would say are present: 'creating API documentation', 'generating SDKs', 'ensuring API contract compliance', 'OpenAPI'. A few common synonyms are missing (e.g., 'Swagger', 'REST API', 'spec'), which fits the 'good keyword coverage; a few natural terms missing' anchor rather than the comprehensive synonym coverage of a 5.

4 / 5

Distinctiveness Conflict Risk

'OpenAPI 3.1 specifications' carves out a clear niche with distinct, contract-related triggers, giving minimal conflict risk. It is not a 5 because 'creating API documentation' has minor overlap risk with generic documentation-writing skills.

4 / 5

Total

17

/

20

Passed

Validation

100%

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

Reviewed

Table of Contents

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.