CtrlK
BlogDocsLog inGet started
Tessl Logo

mcclowes/api-design

Use when designing, reviewing, or implementing HTTP APIs — error and warning handling, resource state and lifecycle, read-endpoint structure, pagination, and authentication. Triggers on error responses and formats, response envelopes, webhook payloads, how an endpoint should fail; modelling a resource lifecycle (status fields, state machines, webhook event names, enum vs parseable string); structuring read endpoints (screen-shaped/BFF vs canonical resource, aggregation, cursor vs offset pagination); and auth design (security schemes, API keys vs bearer tokens, stepped-up tokens). Apply whenever an API surfaces a failure, state change, view of data, or auth requirement to a client.

96

1.70x
Quality

90%

Does it follow best practices?

Impact

99%

1.70x

Average score across 8 eval scenarios

SecuritybySnyk

Passed

No known issues

Overview
Quality
Evals
Security
Files

Quality

Content

85%

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

This is a strong, well-structured API design skill that provides genuinely opinionated, actionable guidance across multiple interconnected concerns. Its progressive disclosure is excellent, with a clear overview that stands alone while pointing to detailed references. The main weakness is moderate verbosity in explanatory prose — some rationale sections could be tightened without losing clarity, particularly the 'why' explanations and the US spelling paragraph.

Suggestions

Tighten the 'Why it's shaped this way' seven principles into a compact numbered list without the preamble sentence, and trim the US spelling paragraph to 2-3 sentences focusing on the rule and one example rather than the full justification.

DimensionReasoningScore

Conciseness

The skill is mostly efficient and covers genuinely non-obvious design decisions, but several sections over-explain rationale that Claude could infer (e.g., the extended 'Why it's shaped this way' section, the lengthy prose justifying the event/status/issue split). The US spelling paragraph is thorough but verbose for what amounts to 'use US spelling for machine-readable identifiers.' Some tightening would improve token efficiency.

2 / 3

Actionability

The skill provides concrete, actionable guidance throughout: a complete JSON example of the issues array, a detailed field table with types and purposes, specific naming conventions with examples (e.g., `payment.validation.missing_field`), explicit parsing rules ('split on `.` and match prefixes'), and a clear 'Applying this skill' section with specific steps for each use case. The design rules section gives precise do/don't guidance.

3 / 3

Workflow Clarity

The 'Applying this skill' section provides clear, sequenced workflows for each major use case (designing failures, lifecycle, read endpoints, auth, reviewing). The state/event/issue separation is presented as a clear decision framework with explicit questions to ask. For a design-guidance skill (not a destructive/batch operation), the workflows are appropriately structured with clear decision points.

3 / 3

Progressive Disclosure

The skill is excellently structured as an overview with well-signaled one-level-deep references to four detailed reference files (error-handling.md, event-status-design.md, view-vs-data-endpoints.md, auth-schemes.md, consuming-in-react.md). Each reference is introduced with enough context to know when to consult it, and the main file provides sufficient standalone value without requiring the references for basic understanding.

3 / 3

Total

11

/

12

Passed

Description

92%

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 is a strong, detailed description that clearly articulates specific capabilities across multiple API design domains and provides explicit trigger guidance with 'Use when', 'Triggers on', and 'Apply whenever' clauses. The main weakness is its breadth — covering error handling, auth, pagination, state machines, and webhooks in one skill creates potential overlap with more specialized skills. The description is well-structured but borders on verbose, though the detail serves the purpose of disambiguation.

DimensionReasoningScore

Specificity

The description lists multiple specific concrete actions and concepts: error/warning handling, resource state and lifecycle, read-endpoint structure, pagination, authentication, response envelopes, webhook payloads, state machines, cursor vs offset pagination, API keys vs bearer tokens, BFF patterns, and more.

3 / 3

Completeness

Clearly answers both 'what' (designing/reviewing/implementing HTTP APIs across error handling, resource lifecycle, read endpoints, pagination, auth) and 'when' with explicit triggers ('Use when designing, reviewing, or implementing HTTP APIs', 'Triggers on...', 'Apply whenever an API surfaces a failure, state change, view of data, or auth requirement').

3 / 3

Trigger Term Quality

Excellent coverage of natural terms users would say: 'HTTP APIs', 'error responses', 'pagination', 'authentication', 'API keys', 'bearer tokens', 'webhook', 'cursor vs offset', 'state machines', 'response envelopes', 'BFF'. These are terms developers naturally use when discussing API design.

3 / 3

Distinctiveness Conflict Risk

While the description is detailed about HTTP API design specifically, the breadth of topics covered (error handling, auth, pagination, state management) is quite wide and could overlap with more focused skills on authentication, error handling, or webhook design individually. The scope is broad enough that it might conflict with adjacent API-related skills.

2 / 3

Total

11

/

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.

Reviewed

Table of Contents