CtrlK
BlogDocsLog inGet started
Tessl Logo

api-documenter

Master API documentation with OpenAPI 3.1, AI-powered tools, and modern developer experience practices. Create interactive docs, generate SDKs, and build comprehensive developer portals. Use PROACTIVELY for API documentation or developer portal creation.

48

Quality

52%

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 ./skills/api-documenter/SKILL.md

The canonical home for this skill is jbvc/api-documenter

SKILL.md
Quality
Evals
Security

Quality

Content

20%

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 verbose persona description rather than actionable guidance: it enumerates capabilities and knowledge Claude already has and provides no executable code or commands. Workflows and file structure are present but lack validation checkpoints and external references.

Suggestions

Replace the capability/knowledge bullet lists with concrete, executable guidance — e.g., a minimal OpenAPI 3.1 snippet, an SDK-generation command, or a validation command — so the skill instructs rather than describes.

Cut the 'Knowledge Base' and 'Capabilities' sections that restate concepts Claude already knows; keep only the non-obvious workflow specifics to respect the token budget.

Add explicit validation/verification steps to the workflow (e.g., validate the OpenAPI spec with a linter before publishing) and split detailed reference material into one-level-deep bundle files in references/.

DimensionReasoningScore

Conciseness

The ~175-line body is a persona/capability dump enumerating concepts Claude already knows (OpenAPI 3.1, OAuth 2.0, JWT, CORS, Swagger UI, Redoc, Docusaurus, etc.) with a 'Knowledge Base' section restating familiar territory, heavily padding the context.

1 / 3

Actionability

There is no executable code, no commands, and no concrete examples; the 'Instructions' and 'Response Approach' sections describe rather than instruct (e.g., 'Create or validate specifications with examples and auth flows').

1 / 3

Workflow Clarity

A sequence is present (4-step 'Instructions' and 8-step 'Response Approach'), but there are no validation checkpoints or feedback loops — the steps are high-level and abstract.

2 / 3

Progressive Disclosure

The single file is organized into sections but is a monolithic 175-line capability list with no bundle files and no one-level-deep references; content that should be split out is inline.

2 / 3

Total

6

/

12

Passed

Description

85%

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 is well-formed: it states concrete capabilities and includes an explicit use-trigger, giving it a clear niche. Its main weakness is trigger-term breadth — only two trigger phrases are named and common variations are absent.

DimensionReasoningScore

Specificity

It lists multiple concrete actions with objects — 'Create interactive docs, generate SDKs, and build comprehensive developer portals' — paralleling the score-3 anchor, though the leading 'Master API documentation with ... practices' clause is fuzzier.

3 / 3

Completeness

It answers both 'what' (create docs, generate SDKs, build portals) and 'when' with an explicit trigger clause 'Use PROACTIVELY for API documentation or developer portal creation', satisfying the score-3 anchor.

3 / 3

Trigger Term Quality

Natural terms like 'API documentation' and 'developer portal' appear, but coverage misses common variations users would say (e.g., 'OpenAPI spec', 'Swagger', 'API reference'), and 'Use PROACTIVELY' is a meta-instruction rather than a user trigger.

2 / 3

Distinctiveness Conflict Risk

API documentation and developer portal creation is a clear niche with distinct triggers unlikely to overlap with unrelated skills.

3 / 3

Total

11

/

12

Passed

Validation

93%

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

Validation15 / 16 Passed

Validation for skill structure

CriteriaDescriptionResult

metadata_version

'metadata.version' is missing

Warning

Total

15

/

16

Passed

Repository
rmyndharis/antigravity-skills
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.