CtrlK
BlogDocsLog inGet started
Tessl Logo

api-designer

Use when designing REST or GraphQL APIs, creating OpenAPI specifications, or planning API architecture. Invoke for resource modeling, versioning strategies, pagination patterns, error handling standards.

84

Quality

80%

Does it follow best practices?

Impact

Pending

No eval scenarios have been run

SecuritybySnyk

Passed

No known issues

Optimize this skill with Tessl

npx tessl skill review --optimize ./skills/api-designer/SKILL.md
SKILL.md
Quality
Evals
Security

Quality

Discovery

82%

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

This description excels at trigger term coverage and distinctiveness, providing a rich set of natural keywords that clearly define its niche in API design. Its main weakness is that it reads more like a list of triggers than a complete skill description—it tells Claude when to use the skill but doesn't explicitly state what the skill does or produces. Adding a brief 'what it does' statement would elevate it significantly.

Suggestions

Add an explicit 'what' statement at the beginning, e.g., 'Guides REST and GraphQL API design, generates OpenAPI specifications, and recommends architecture patterns.'

DimensionReasoningScore

Specificity

Lists multiple specific concrete actions: designing REST or GraphQL APIs, creating OpenAPI specifications, planning API architecture, resource modeling, versioning strategies, pagination patterns, error handling standards.

3 / 3

Completeness

The 'when' is well-covered with explicit 'Use when...' and 'Invoke for...' clauses, but the 'what' is only implied through the trigger terms rather than explicitly stated. The description tells Claude when to use it but doesn't clearly state what the skill actually does (e.g., 'Guides API design decisions and generates specifications'). However, the 'Use when' clause is present and strong, so it narrowly misses a 3 due to the weak 'what' component.

2 / 3

Trigger Term Quality

Includes strong natural keywords users would say: 'REST', 'GraphQL', 'API', 'OpenAPI', 'versioning', 'pagination', 'error handling', 'resource modeling'. These cover common variations of how users would describe API design tasks.

3 / 3

Distinctiveness Conflict Risk

The description carves out a clear niche around API design with distinct triggers like 'REST', 'GraphQL', 'OpenAPI specifications', 'pagination patterns', and 'versioning strategies' that are unlikely to conflict with other skills.

3 / 3

Total

11

/

12

Passed

Implementation

77%

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

This is a well-crafted API design skill with strong actionability—concrete CLI commands, a complete OpenAPI template, and RFC 7807 examples make it immediately usable. The workflow is clearly sequenced with validation gates. The main weaknesses are moderate verbosity (the large inline template and some redundant constraints Claude already knows) and the inability to verify the referenced files in the progressive disclosure table.

Suggestions

Move the large OpenAPI 3.1 template to a separate bundle file (e.g., `references/openapi-template.yaml`) and reference it from the main skill to reduce inline bulk.

Trim the MUST DO/MUST NOT DO lists to only non-obvious constraints—remove items like 'follow REST principles' and 'don't ignore HTTP status code semantics' that Claude already knows.

Remove or significantly trim the 'Knowledge Reference' section at the bottom, as it's just a list of concepts Claude is already familiar with and adds no actionable value.

DimensionReasoningScore

Conciseness

The skill is generally well-structured but the large OpenAPI template (~80 lines) is borderline excessive for inline content—it could be referenced from a separate file. The MUST DO/MUST NOT DO lists contain some items Claude would already know (e.g., 'use proper HTTP methods', 'don't ignore HTTP status code semantics'). The Knowledge Reference section at the bottom is a list of concepts Claude already knows and adds no value.

2 / 3

Actionability

The skill provides fully executable, copy-paste-ready OpenAPI 3.1 YAML, a concrete RFC 7807 error response example, specific CLI commands for linting and mocking (`npx @redocly/cli lint`, `npx @stoplight/prism-cli mock`), and a clear output checklist. Guidance is concrete and specific throughout.

3 / 3

Workflow Clarity

The core workflow is clearly sequenced with 6 numbered steps, includes an explicit validation checkpoint (step 4: lint before proceeding), a verification step (step 5: mock and test), and the output checklist reinforces that validation must pass. The feedback loop is implicit but the 'validate before proceeding' gate is clear.

3 / 3

Progressive Disclosure

The Reference Guide table with 'Load When' context is an excellent progressive disclosure pattern pointing to 5 reference files. However, no bundle files are provided, so these references are unverifiable. Additionally, the large OpenAPI template is inlined rather than being in a referenced file, which bloats the main skill body and would be better as a separate template file.

2 / 3

Total

10

/

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
Jeffallan/claude-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.