CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

api-design

REST API design patterns including resource naming, status codes, pagination, filtering, error responses, versioning, and rate limiting for production APIs.

1.30x
Quality

73%

Does it follow best practices?

Impact

94%

1.30x

Average score across 3 eval scenarios

SecuritybySnyk

Passed

No findings from the security scan

Fix and improve this skill with Tessl

tessl review fix ./skills/api-design/SKILL.md

The canonical home for this skill is api-design in affaan-m/ECC

SKILL.md
Quality
Evals
Security

Quality

Content

71%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 actionable reference with concrete executable examples across TypeScript, Python, and Go, plus a useful pre-ship checklist. It is dragged down by re-explaining HTTP basics Claude already knows and by keeping everything monolithically in SKILL.md instead of splitting detailed material into reference files.

Suggestions

Trim or compress sections Claude already knows (method semantics table, standard status-code meanings), keeping only the project-specific conventions such as 409 vs 422 usage and the error envelope format.

Move the per-language implementation examples (TypeScript/Django/Go) into references/ files (e.g. references/implementation-examples.md) and keep one canonical example inline, turning SKILL.md into a lean overview.

Keep the two pagination strategies but drop one of the three duplicated create-endpoint implementations, or reduce them to the differences that matter per language.

DimensionReasoningScore

Conciseness

The body is mostly terse tables and code, but it restates HTTP basics Claude already knows (the Method Semantics table with GET/Safe/Idempotent, and a Status Code Reference explaining e.g. '404 Not Found — Resource doesn't exist'), and three full language implementations (TypeScript, Django, Go) duplicate the same create-with-validation pattern. That fits 'mostly efficient but includes some unnecessary explanation or could be tightened' rather than the score-4 anchor, since trimming the basics and two of the three implementations would lose little.

3 / 5

Actionability

Guidance is fully executable: copy-paste-ready Zod/Next.js and DRF examples with Location headers and field-level error details, concrete SQL for cursor pagination ('LIMIT 21; -- fetch one extra to determine has_next'), exact JSON envelopes, and specific URL/query syntax. The common cases are covered; only the Go snippet's undefined helpers (writeError, writeJSON) are a minor gap, so it sits at the score-5 anchor rather than dropping to 4.

5 / 5

Workflow Clarity

'When to Activate' scopes usage and the closing 'API Design Checklist' ('Before shipping a new endpoint: ...') provides an explicit validation gate covering naming, status codes, auth, and leak prevention. However, this is a reference/patterns skill with no multi-step sequence or error-recovery feedback loop, so it matches 'clear sequence with most checkpoints; minor validation gaps' better than the score-5 anchor's explicit validate-fix-retry workflow.

4 / 5

Progressive Disclosure

No bundle files exist (no references/, scripts/, or assets/), and roughly 500 lines — including three language-specific implementation examples and detailed filtering/sorting syntax — are all inlined in SKILL.md where a split into reference files belongs. Section headers are clear (so not the score-2 'minimal structure' case), but this is squarely 'some structure... content that should be separate is inline'.

3 / 5

Total

15

/

20

Passed

Description

66%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 specific, well-scoped description with strong natural trigger terms for the API-design domain. Its main weakness is the absence of an explicit 'Use when...' clause, which both caps completeness and leaves activation guidance only weakly implied.

Suggestions

Add an explicit trigger clause, e.g. 'Use when designing or reviewing REST API endpoints, adding pagination or filtering, choosing status codes, or planning API versioning.'

Include a few more natural phrasings users would say, such as 'endpoints', 'RESTful', or 'API contract', to broaden trigger coverage.

Rephrase the topic list with action verbs (e.g. 'Design resource URLs, select status codes, implement cursor pagination') to strengthen specificity.

DimensionReasoningScore

Specificity

Lists several concrete subtopics ("resource naming, status codes, pagination, filtering, error responses, versioning, and rate limiting") with near-comprehensive coverage of the domain, but they are stated as topics rather than actions (no verbs like 'Designs' or 'Returns'), matching the 'several specific actions; minor gaps' anchor rather than the fully comprehensive score-5 anchor.

4 / 5

Completeness

The 'what' is clear (REST API design patterns with an enumerated scope), but there is no 'Use when...' clause or equivalent explicit trigger guidance — 'for production APIs' only weakly implies when — and the judging guidelines cap completeness at 3 in that case. It is not a 4 because the 'when' is absent rather than merely imprecise.

3 / 5

Trigger Term Quality

Natural terms users would say are well covered — "REST API", "pagination", "status codes", "rate limiting", "versioning", "error responses" — but a few common variants are missing ("endpoints", "RESTful", "API contract"), which fits 'good keyword coverage; a few natural terms missing' rather than the comprehensive score-5 anchor.

4 / 5

Distinctiveness Conflict Risk

The enumerated scope ("resource naming, status codes, pagination, filtering, error responses, versioning, and rate limiting") establishes a clear, mostly distinct niche, but there is minor overlap risk with closely related skills such as OpenAPI/Swagger documentation or general backend-development skills, matching the score-4 anchor rather than the minimal-conflict score-5 anchor.

4 / 5

Total

15

/

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 (524 lines); consider splitting into references/ and linking

Warning

frontmatter_unknown_keys

Unknown frontmatter key(s) found; consider removing or moving to metadata

Warning

Total

14

/

16

Passed

Repository

valeriibeck-star/claude-skills

Path

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