CtrlK
BlogDocsLog inGet started
Tessl Logo

route-to-openapi

Generates RESTful API documentation (OpenAPI 3.0 / Swagger spec) by scanning route definitions in code for Flask, FastAPI, Express, Gin, and other frameworks. Trigger when users ask about API documentation, OpenAPI, Swagger, endpoint docs, generating docs from code, or extracting endpoints.

70

Quality

86%

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

SKILL.md
Quality
Evals
Security

Quality

Content

88%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.

A well-structured, highly actionable tool skill: executable quick-start commands that match the real script, dense tables instead of explanatory prose, and an unambiguous single-command workflow. The only real improvement is moving the long output example and framework detail into reference files to slim the main body.

DimensionReasoningScore

Conciseness

The body is efficient: framework support, extraction capabilities, and path-parameter conversion are conveyed via compact tables rather than prose, and it assumes Claude already knows OpenAPI/Swagger rather than explaining them. Minor trimming is possible — the 46-line JSON output example repeats much of what the capability and parameter tables already convey — so it does not reach the lean 'every token earns its place' anchor 5.

4 / 5

Actionability

The Quick Start provides copy-paste-ready commands covering the common cases (scan with defaults, format/output selection, forced framework, metadata, server URLs), and the parameter table documents every CLI flag with defaults. The commands were verified to match the actual script's argparse interface, and the JSON output example shows exactly what the artifact looks like.

5 / 5

Workflow Clarity

This is a single-action tool skill: run `python scripts/generate_api_doc.py <dir>` with documented options. The single action is unambiguous, with auto-detection behavior and explicit override flags explained, and the operation is non-destructive (read-only scan plus optional file output), so no validation checkpoint is required under the rubric.

5 / 5

Progressive Disclosure

The body is well organized into clear sections (Quick Start, frameworks, capabilities, parameters, output, prerequisites) and its only bundle reference — `scripts/generate_api_doc.py` — is a real file, correctly pathed, and used consistently. At ~130 lines with everything inlined (the full output example and per-framework detail could live in a reference file), it sits just below the cleanly split structure of anchor 5.

4 / 5

Total

18

/

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 that clearly and explicitly states both what the skill does and when to use it, with natural trigger terms and a well-defined niche. It only falls slightly short of top marks on specificity (two core actions rather than a comprehensive action list) and trigger synonym coverage.

Suggestions

Add a couple of common user phrasings as triggers, e.g. 'REST API docs', 'API spec', or 'generate Swagger/OpenAPI spec', to broaden natural-term coverage.

Mention one more concrete capability in the what-clause (e.g. 'extracts HTTP methods, paths, parameters, and request/response models') to raise specificity from a two-action description to a comprehensive action list.

DimensionReasoningScore

Specificity

Concrete actions are explicitly stated: 'Generates RESTful API documentation (OpenAPI 3.0 / Swagger spec)' and 'scanning route definitions in code', with the output standard and input source both named. It stops short of the anchor-5 'comprehensive' list of multiple distinct actions (one generate action driven by one scan action), but clearly exceeds the 1-2-action anchor 3 given the named spec, frameworks, and mechanism.

4 / 5

Completeness

The 'what' is explicit ('Generates RESTful API documentation (OpenAPI 3.0 / Swagger spec) by scanning route definitions in code') and the 'when' is explicit with concrete trigger phrases ('Trigger when users ask about API documentation, OpenAPI, Swagger, endpoint docs, generating docs from code, or extracting endpoints'). This matches the anchor-5 example structure of both what and when stated concretely; third-person voice is used correctly.

5 / 5

Trigger Term Quality

Natural trigger terms include 'API documentation', 'OpenAPI', 'Swagger', 'endpoint docs', 'generating docs from code', and 'extracting endpoints' — good coverage with sensible variations. A few plausible user phrases are missing (e.g. 'REST API', 'API spec', 'spec file'), which keeps it below the comprehensive synonym coverage of anchor 5.

4 / 5

Distinctiveness Conflict Risk

The OpenAPI/Swagger-spec-from-code niche is well staked out with framework names (Flask, FastAPI, Express, Gin), making confusion with adjacent skills unlikely. The broad term 'API documentation' could also match hand-written or general documentation tasks, giving minor overlap risk rather than the minimal risk of anchor 5.

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
zebbern/claude-code-guide
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.