CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

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.

71

Quality

89%

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

86%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-constructed skill body: concrete, executable guidance with a validated six-step workflow, hard constraints, and a clean reference table that keeps detail one level deep in real bundle files. The only weaknesses are minor — no explicit fix-and-retry loop around the validation steps, and a low-value keyword 'Knowledge Reference' section plus attribution footer that could be trimmed.

DimensionReasoningScore

Conciseness

The body is efficient and instruction-focused — no tutorials on concepts Claude already knows, and every section (workflow, constraints, templates, checklist) is directive. Minor trimming is possible: the "Knowledge Reference" section is a keyword list (REST architecture, OAuth 2.0, JWT, HATEOAS...) that adds little actionable value, and the maintainer/documentation footer is padding.

4 / 5

Actionability

Fully executable, copy-paste-ready guidance: a complete OpenAPI 3.1 starter template, runnable commands ("npx @redocly/cli lint openapi.yaml", "npx @stoplight/prism-cli mock openapi.yaml"), a concrete RFC 7807 JSON example with extension rules, and a delivery checklist. This matches the top anchor for copy-paste-ready code covering the common cases.

5 / 5

Workflow Clarity

The six-step Core Workflow is clearly sequenced with explicit validation checkpoints ("validate before proceeding: npx @redocly/cli lint openapi.yaml"), a mock-verification step, and an Output Checklist ending with a required passing lint result. It stops short of the top anchor because there is no explicit error-recovery feedback loop (what to do when lint or mock verification fails), so a minor validation gap remains.

4 / 5

Progressive Disclosure

The body is a clear overview with a reference table giving per-topic 'Load When' conditions pointing to five one-level-deep references (rest-patterns.md, versioning.md, pagination.md, error-handling.md, openapi.md), all of which exist in references/. The large inline OpenAPI template is justified as a copy-paste starter rather than misplaced reference material, so structure and navigation are easy.

5 / 5

Total

18

/

20

Passed

Description

88%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: it explicitly states what the skill does and when to invoke it, using concrete domain actions and natural trigger phrases with no fluff or over-claims. Keyword coverage is good but misses a few common synonyms like "Swagger" or "endpoint design", and broad terms like "REST API" create minor overlap risk with implementation-oriented skills.

DimensionReasoningScore

Specificity

Lists multiple specific concrete actions with comprehensive coverage: "designing REST or GraphQL APIs", "creating OpenAPI specifications", "planning API architecture", plus "resource modeling, versioning strategies, pagination patterns, error handling standards". This matches the anchor for multiple specific concrete actions; no vague filler or buzzwords are present.

5 / 5

Completeness

Explicitly answers both questions: the 'what' is stated concretely ("designing REST or GraphQL APIs, creating OpenAPI specifications, or planning API architecture") and the 'when' via two explicit trigger clauses ("Use when designing..." and "Invoke for resource modeling, versioning strategies, pagination patterns, error handling standards"). This mirrors the anchor example that clearly answers both what and when with concrete trigger phrases.

5 / 5

Trigger Term Quality

Good natural keyword coverage — "REST", "GraphQL", "OpenAPI", "API architecture", "resource modeling", "versioning", "pagination", "error handling" are terms users would actually say. Falls short of the top anchor because common synonyms and variations (e.g., "Swagger", "endpoint design", "API spec") are missing, which keeps it at 'good coverage, a few natural terms missing' rather than comprehensive.

4 / 5

Distinctiveness Conflict Risk

The design/architecture framing ("API architecture", "OpenAPI specifications", "resource modeling", "versioning strategies") carves a mostly distinct niche from implementation-focused skills. Minor overlap risk remains because broad triggers like "REST API" could also match closely related implementation skills (e.g., the fastapi-expert listed in related-skills), fitting 'mostly distinct; minor overlap risk'.

4 / 5

Total

18

/

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

Jeffallan/claude-skills

Path

skills/api-designer/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.