CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

rest-api-design

Designs RESTful APIs with proper resource naming, HTTP methods, status codes, and response formats. Use when building new APIs, establishing API conventions, or designing developer-friendly interfaces.

Quality

82%

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

67%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, convention-style reference with concrete examples for naming, response shapes, and query parameters, and no external-file overhead. Its weaknesses are re-teaching textbook HTTP knowledge in two tables, missing an error-response example, and having no explicit design workflow.

Suggestions

Replace or condense the HTTP Methods and Status Codes tables with only the project-specific conventions Claude would not already know (e.g., which code this API returns for validation vs. auth failures), or move the exhaustive table to a reference file.

Add an error-response JSON example (e.g., for 400/401) mirroring the success format, since error shape is a common design decision the skill currently leaves undefined.

Either show a concrete '/api/v1/users' versioning example alongside the existing URL examples or drop the bare 'Version API via URL path' bullet, and consider a brief 3-4 step design sequence (identify resources → define URLs → choose methods/status codes → define response format) to guide application of the conventions.

DimensionReasoningScore

Conciseness

The body is tight and unpadded, but the HTTP Methods table (GET/POST/PUT/PATCH/DELETE with purposes and idempotency) and the Status Codes table restate textbook knowledge Claude already has. This is more than the 'minor instances of over-explanation' of anchor 4, though the good/bad URL examples and project-specific response formats are genuinely additive beyond anchor 2.

3 / 5

Actionability

Concrete, copy-paste-ready convention examples cover the common cases: good/bad resource URLs, single- and collection-response JSON shapes, and query-parameter syntax for filtering, sorting, and pagination. Minor gaps keep it below anchor 5: no error-response body example (despite listing 400/401/403), and the '/api/v1/' versioning convention is stated without an example.

4 / 5

Workflow Clarity

Sections are logically ordered to imply a design flow (naming → methods → codes → response format) and the guidance is unambiguous for a single-purpose conventions skill, so the simple-skill exception applies. No destructive or batch operations exist, so validation checkpoints are not required; it falls short of anchor 5 only because there is no explicit design sequence or self-review checklist.

4 / 5

Progressive Disclosure

The skill is a well-sectioned, self-contained single sheet with no bundle files and no buried or nested references, so nothing is misplaced (above anchor 3). It does not reach anchor 5 because at ~97 lines the status-code list is incomplete (no 5xx) and the thin 'Best Practices' section suggests organization gaps that a split or fuller reference structure would resolve.

4 / 5

Total

15

/

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 in third-person voice with an explicit 'Use when...' clause covering both what the skill does and when to use it. The main weaknesses are missing common trigger synonyms ('endpoints', 'HTTP', 'REST API') and one slightly broad trigger phrase that could overlap with adjacent skills.

DimensionReasoningScore

Specificity

The description enumerates four concrete capability areas — 'proper resource naming, HTTP methods, status codes, and response formats' — giving comprehensive coverage of the REST API design domain. This matches the anchor-5 example's breadth (multiple specific actions, comprehensive coverage) rather than anchor 4, which requires minor gaps in coverage.

5 / 5

Completeness

It clearly answers both questions: the 'what' is explicit ('Designs RESTful APIs with proper resource naming, HTTP methods, status codes, and response formats') and the 'when' is an explicit 'Use when...' clause with three concrete trigger phrases. This matches anchor 5 rather than anchor 4, where the 'when' is present but less specific.

5 / 5

Trigger Term Quality

Natural phrases users would say are present — 'building new APIs', 'establishing API conventions', 'designing developer-friendly interfaces' — giving good keyword coverage. It falls short of anchor 5 because common variations like 'endpoints', 'HTTP', or plain 'REST API' phrasings are missing.

4 / 5

Distinctiveness Conflict Risk

'Designs RESTful APIs' carves out a clear niche, but the trigger 'designing developer-friendly interfaces' is broad enough to overlap with general web-development or UX skills. Mostly distinct with minor overlap risk matches anchor 4; anchor 5 requires minimal conflict risk across all triggers.

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

secondsky/claude-skills

Path

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