CtrlK
BlogDocsLog inGet started
Tessl Logo

api-design

REST API design patterns including resource naming, status codes, pagination, filtering, error responses, versioning, and rate limiting for production APIs. Use when designing or reviewing REST endpoints, resource names, status codes, pagination, or versioning.

61

Quality

73%

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-design/SKILL.md
SKILL.md
Quality
Evals
Security

Quality

Content

63%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-organized, highly concrete reference skill with strong code examples and a useful pre-ship checklist. Its weaknesses are redundancy (re-explaining basic HTTP semantics and status codes Claude already knows) and a monolithic 525-line single-file structure where implementation examples and detailed reference tables belong in separate bundle files.

Suggestions

Trim or cut the 'Method Semantics' and 'Status Code Reference' sections to only convention decisions Claude wouldn't infer (e.g., 'include Location header on 201', '422 for semantic validation'), removing standard HTTP definitions Claude already knows.

Move the per-language implementation examples (TypeScript/Next.js, Python/DRF, Go) into a references/ file (e.g., references/implementation-examples.md) and keep only one inline, keeping SKILL.md as a concise overview.

Consider moving the pagination, filtering/sorting, and rate-limiting detail tables into a references/ file linked from short summary sections, so the ~500-line body shrinks toward an overview with well-signaled one-level-deep references.

DimensionReasoningScore

Conciseness

Mostly efficient tables and code with no padded prose, but it re-teaches concepts Claude already knows: the Method Semantics table (GET/POST/PUT/DELETE idempotency) and a ~20-line Status Code Reference explaining 400/401/403/404, plus standard Bearer-token examples. This goes beyond the 'minor instances' of anchor 4, while the terse convention-driven content keeps it above anchor 2.

3 / 5

Actionability

Highly executable guidance — a complete Next.js zod handler, cursor-pagination SQL ('WHERE id > :cursor_id ... LIMIT 21'), concrete filter/sort syntax ('?price[gte]=10', '?sort=-created_at'), and a shipping checklist. The Go and DRF examples depend on undefined helpers (writeError, writeJSON, UserService), which are the minor gaps that keep it at anchor 4 rather than 5.

4 / 5

Workflow Clarity

The design task is not destructive/batch so the cap does not apply; the deprecation timeline is a clear numbered sequence and the 'API Design Checklist' provides an explicit pre-ship checkpoint. It lacks any validate-fix-retry feedback loop, so it fits anchor 4 rather than 5, and the explicit checklist keeps it above anchor 3.

4 / 5

Progressive Disclosure

The 525-line body is entirely inline with no bundle files at all; per-language implementation examples (TypeScript/Python/Go) and the detailed pagination and filtering reference tables clearly belong in separate references files. Good section headers keep it navigable — above anchor 2's unstructured wall — but the missing file split fits anchor 3 ('content that should be separate is inline').

3 / 5

Total

14

/

20

Passed

Description

83%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 names a clear niche, enumerates concrete capability areas, and includes an explicit 'Use when...' clause with natural trigger phrases. The only weaknesses are topic-oriented (rather than action-oriented) framing and a few missing synonyms like 'HTTP' and 'error handling'.

DimensionReasoningScore

Specificity

Enumerates seven concrete topic areas ("resource naming, status codes, pagination, filtering, error responses, versioning, and rate limiting") but frames them as design-pattern topics rather than concrete actions, leaving minor gaps versus anchor 5.

4 / 5

Completeness

Explicitly answers what ("REST API design patterns including...") and when ("Use when designing or reviewing REST endpoints, resource names, status codes, pagination, or versioning") with concrete trigger phrases, matching anchor 5.

5 / 5

Trigger Term Quality

Natural user terms like "REST endpoints", "status codes", "pagination", and "versioning" appear in the trigger clause, but common synonyms such as "API design", "HTTP", and "error handling" are missing, matching anchor 4 rather than 5.

4 / 5

Distinctiveness Conflict Risk

The REST API design niche is clearly distinct with domain-specific triggers, with only minor overlap risk against generic web-development or code-review skills, fitting anchor 4.

4 / 5

Total

17

/

20

Passed

Validation

87%

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

Validation — 14 / 16 Passed

Validation for skill structure

CriteriaDescriptionResult

skill_md_line_count

SKILL.md is long (525 lines); consider splitting into references/ and linking

Warning

metadata_version

'metadata.version' is missing

Warning

Total

14

/

16

Passed

Repository
affaan-m/ECC
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.