CtrlK
BlogDocsLog inGet started
Tessl Logo

api-design

Design or review an HTTP/REST/GraphQL API for versioning, pagination, error shapes, idempotency, auth, and evolvability. Use when asked to "design an API", "shape the endpoints", "design the schema", "add a new endpoint", "review this API", or when building/modifying a public or internal HTTP surface. Complements `design-an-interface` (which is interface-agnostic) by covering HTTP-specific concerns like status codes, cache headers, and breaking-change management.

80

Quality

100%

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

100%

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

A lean, well-structured API design skill that assumes Claude's competence, delivers concrete REST/GraphQL guidance with tables and templates, and sequences an 8-step process capped by a validation checklist. It is self-contained and cleanly sectioned rather than sprawling.

DimensionReasoningScore

Conciseness

Dense and token-efficient throughout — e.g. '200 OK with {"error": "not found"} is a lie. 404 says not found.' — and it assumes Claude's knowledge (the status-code table never explains what HTTP is); every section earns its place.

3 / 3

Actionability

Provides concrete, executable guidance: a method→status-code table, specific URL examples ('POST /users', not 'POST /createUser'), a copy-paste error-shape JSON, an idempotency-key pattern, and a ready-to-fill write-up template; absence of runnable program code is appropriate for an instruction/design skill.

3 / 3

Workflow Clarity

A clearly sequenced 8-step process (gather contract → naming → methods/status → pagination → error shape → idempotency → versioning → review/write-up) with a one-round question gate in Step 1 and a success_criteria checklist serving as the final validation gate.

3 / 3

Progressive Disclosure

No bundle files exist and the body references only output artifacts (.gsd/DECISIONS.md) and sibling skills, not nested skill files; content is well-organized into clearly labeled semantic sections (<objective>, <context>, <core_principle>, <process>, <anti_patterns>, <success_criteria>) with no nested-reference problem.

3 / 3

Total

12

/

12

Passed

Description

100%

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, concise description that states concrete capabilities, gives explicit natural-language triggers for when to invoke it, and clearly differentiates it from the related generic interface-design skill. No vague fluff or over-claims.

DimensionReasoningScore

Specificity

Enumerates multiple concrete capability areas — 'versioning, pagination, error shapes, idempotency, auth, and evolvability' — matching the anchor for listing several specific actions; uses third-person voice ('Design or review').

3 / 3

Completeness

Clearly answers both 'what' (design/review an HTTP/REST/GraphQL API for the listed concerns) and 'when' via an explicit 'Use when asked to...' clause with concrete triggers.

3 / 3

Trigger Term Quality

Quotes natural user phrases — 'design an API', 'shape the endpoints', 'design the schema', 'add a new endpoint', 'review this API' — plus 'building/modifying a public or internal HTTP surface', giving good coverage of terms users would actually say.

3 / 3

Distinctiveness Conflict Risk

Explicitly carves a niche from the sibling skill — 'Complements `design-an-interface` (which is interface-agnostic) by covering HTTP-specific concerns like status codes, cache headers, and breaking-change management' — making overlap and misfires unlikely.

3 / 3

Total

12

/

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.

Validation16 / 16 Passed

Validation for skill structure

No warnings or errors.

Repository
gsd-build/gsd-2
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.