CtrlK
BlogDocsLog inGet started
Tessl Logo

api-doc-generator

This skill should be used when the user asks to "generate API docs", "create API documentation", "generate curl examples", "create developer docs", or mentions generating documentation, curl examples, or developer guides from OpenAPI/OAS specifications.

47

Quality

49%

Does it follow best practices?

Impact

No eval scenarios have been run

SecuritybySnyk

Passed

No known issues

Optimize this skill with Tessl

npx tessl skill review --optimize ./.claude/skills/api-doc-generator/SKILL.md
SKILL.md
Quality
Evals
Security

Quality

Discovery

72%

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

The description excels at providing trigger terms and establishing a clear niche, but it reads more like a list of trigger conditions than a skill description. It lacks a clear statement of what the skill actually does — the concrete capabilities and outputs — instead relying on the trigger phrases to imply functionality. Adding a concise 'what it does' statement would significantly improve it.

Suggestions

Add a clear 'what' statement before the trigger terms, e.g., 'Parses OpenAPI/OAS specification files to generate formatted API documentation including endpoint descriptions, request/response schemas, authentication details, and curl examples.'

Restructure to lead with capabilities and follow with 'Use when...' clause, separating the what from the when for clarity.

DimensionReasoningScore

Specificity

The description mentions generating API docs, curl examples, and developer docs from OpenAPI/OAS specifications, which names the domain and some actions. However, it doesn't list multiple concrete specific actions beyond 'generate' and 'create' — it lacks detail on what the output looks like or what specific processing steps are involved (e.g., parsing endpoints, generating request/response examples, formatting markdown).

2 / 3

Completeness

The description is almost entirely focused on 'when' (trigger conditions) but is weak on 'what' — it doesn't clearly explain what the skill actually does beyond restating the trigger phrases. While it has a 'Use when' equivalent structure, the 'what does this do' portion is essentially absent as a standalone explanation of capabilities.

2 / 3

Trigger Term Quality

Excellent coverage of natural trigger terms: 'generate API docs', 'create API documentation', 'generate curl examples', 'create developer docs', 'OpenAPI', 'OAS specifications', 'developer guides'. These are terms users would naturally use when requesting this kind of work.

3 / 3

Distinctiveness Conflict Risk

The description is clearly scoped to generating API documentation from OpenAPI/OAS specifications, which is a distinct niche. The specific mention of OpenAPI/OAS, curl examples, and developer docs makes it unlikely to conflict with general documentation or coding skills.

3 / 3

Total

10

/

12

Passed

Implementation

27%

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

This skill is overly verbose, spending many tokens describing what the tool does rather than providing concise, actionable instructions. It explains obvious concepts (how to organize docs, how to prompt Claude) and lacks validation/error-handling guidance. The core actionable content—the command to run and its arguments—could be conveyed in roughly 20 lines instead of 100+.

Suggestions

Cut the 'Organizing Documentation', 'Using with Claude', and most of the 'What Gets Generated' sections—these explain things Claude already knows or can infer from the tool's output.

Add a validation/troubleshooting section: what happens with malformed specs, how to verify output completeness, common errors and fixes.

Move detailed output format descriptions and curl example formatting rules to a separate reference file (e.g., OUTPUT_FORMAT.md) and link to it.

Tighten the skill to focus on: (1) the command, (2) key options, (3) a single concise example with expected output, (4) error handling.

DimensionReasoningScore

Conciseness

Significant verbosity throughout. The 'Organizing Documentation' section explains obvious things (commit to repo, publish to GitHub Pages). The 'What Gets Generated' section over-explains output structure. The 'Using with Claude' section is unnecessary—Claude doesn't need to be told how users will prompt it. The 'Curl Examples' section describes features rather than instructing. Much of this content explains things Claude already knows.

1 / 3

Actionability

The core command (`python3 skills/api-doc-generator/scripts/generate_docs.py path/to/spec.yaml [output-dir]`) is concrete and executable, and the example output is helpful. However, much of the content is descriptive rather than instructional—it describes what the tool does rather than providing actionable guidance for edge cases, customization, or troubleshooting.

2 / 3

Workflow Clarity

The workflow is essentially a single command, which is clear enough. However, there's no validation step—no guidance on what to do if the spec is malformed, if the output is incorrect, or how to verify the generated docs are complete. For a tool that processes potentially complex OpenAPI specs, some error handling guidance would be expected.

2 / 3

Progressive Disclosure

Everything is in one monolithic file with no references to external files. The 'What Gets Generated' details, curl example formatting rules, and organizing tips could all be separate references. No bundle files are provided, yet the skill references scripts that presumably exist. The content that should be in the script's README or separate docs is all inlined here.

1 / 3

Total

6

/

12

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.

Validation11 / 11 Passed

Validation for skill structure

No warnings or errors.

Repository
mulesoft/mulesoft-dx
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.