CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

api-design-principles

Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers. Use when designing new APIs, reviewing API specifications, or establishing API design standards.

Quality

62%

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 ./plugins/backend-development/skills/api-design-principles/SKILL.md
SKILL.md
Quality
Evals
Security

Quality

Content

36%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.

The body is a well-formatted but largely redundant restatement of textbook REST/GraphQL knowledge Claude already possesses, with little non-obvious or project-specific content. Concrete worked examples do exist in the bundle, but the body surfaces only one of five bundle files and defines no review or design workflow, so most of the skill's real value is invisible from SKILL.md.

Suggestions

Cut the 'Core Concepts' section (HTTP method semantics, resource-nouns, GraphQL query basics) — Claude already knows this — and retain only non-obvious guidance or project-specific standards.

Reference every bundle file where it is relevant: point the GraphQL section to references/graphql-schema-design.md, the REST section to references/rest-best-practices.md, and surface assets/rest-api-template.py as the starting template.

Add a sequenced workflow for the 'reviewing API specifications' trigger, e.g., 1. check resource naming against the checklist, 2. verify status-code and error-format consistency, 3. confirm pagination and versioning strategy — using assets/api-design-checklist.md as the validation step.

DimensionReasoningScore

Conciseness

Most of the body restates knowledge Claude already has: HTTP method semantics ('GET: Retrieve resources (idempotent, safe)'), 'Resources are nouns (users, orders, products), not verbs', 'Stateless: Each request contains all necessary information', 'Use HTTP Status Codes Correctly: 2xx success, 4xx client errors', and 'Avoid N+1: Use DataLoaders'. These are textbook REST/GraphQL facts, so several sections are unnecessary explanation; it is tighter than rambling prose (not anchor 1's 'heavily padded') but noticeably verbose with several padded sections, matching anchor 2.

2 / 5

Actionability

Some concrete guidance exists — the three versioning snippets ('/api/v1/users', 'Accept: application/vnd.api+json; version=1') and the naming example ('Use plural nouns for collections (/users, not /user)') — but the bulk is high-level directive ('Always paginate large collections', 'Protect your API with rate limits', 'Track query complexity and execution time') with no worked endpoint, schema, or error-format examples in the body. It falls between anchors 2 and 3: more than minimal hints, yet incomplete because the executable patterns (FastAPI endpoints, Relay pagination, DataLoader setup) live in references/ and assets/ and are barely surfaced.

3 / 5

Workflow Clarity

No process is sequenced anywhere in the body: for a skill whose triggers include 'Reviewing API specifications' and 'Establishing API design standards', there is no step order, no review procedure, and no checkpoints — only topical sections. The bundle even contains assets/api-design-checklist.md, which would supply exactly this structure, but it is never referenced. This matches anchor 2 ('rough sequence present but many gaps; steps poorly defined') rather than anchor 3, which requires steps to at least be listed.

2 / 5

Progressive Disclosure

The one signaled reference is good — 'Detailed pattern documentation lives in `references/details.md`. Read that file when the navigation tier above is insufficient' — and it is one level deep (details.md references no further files). However, 4 of the 5 bundle files (references/graphql-schema-design.md, references/rest-best-practices.md, assets/api-design-checklist.md, assets/rest-api-template.py) are never mentioned in the body, leaving most of the bundle undiscoverable — more than the 'minor organization gaps' of anchor 4 but with better structure than anchor 2's inlined-mess.

3 / 5

Total

10

/

20

Passed

Description

70%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.

The description cleanly answers both 'what' and 'when' with an explicit 'Use when...' clause and strong domain keywords (REST, GraphQL, API specifications). Its main weakness is capability framing: 'Master... principles to build intuitive, scalable, and maintainable APIs that delight developers' is aspirational language rather than a list of concrete actions, which caps specificity at 3.

Suggestions

Replace the aspirational capability sentence with concrete actions, e.g., 'Design resource-oriented REST endpoints and GraphQL schemas, choose versioning, pagination, and error-handling strategies, and review API specifications against design standards.'

Drop outcome fluff such as 'that delight developers' — it adds tokens without adding trigger value or capability information.

DimensionReasoningScore

Specificity

The named actions — 'designing new APIs, reviewing API specifications, establishing API design standards' — stay at the domain level and largely restate 'design APIs', while the capability sentence 'build intuitive, scalable, and maintainable APIs that delight developers' is outcome buzzword rather than concrete action. This matches anchor 3 (domain plus 1-2 concrete actions, not comprehensive); not 4 because no specific capabilities (endpoint design, schema design, error formats) are listed, not 2 because the domain and several real use cases are named.

3 / 5

Completeness

Both parts are present: a what ('Master REST and GraphQL API design principles...') and an explicit when ('Use when designing new APIs, reviewing API specifications, or establishing API design standards'). The 'what' leans aspirational ('that delight developers') instead of stating concrete deliverables, which keeps it below anchor 5's 'clearly and explicitly answers both with concrete trigger phrases' on the what side.

4 / 5

Trigger Term Quality

Natural terms 'REST', 'GraphQL', 'API design', 'API specifications', and 'API design standards' cover the main phrases a user would say when needing this skill. Common variations such as 'endpoints', 'OpenAPI', or 'Swagger' are missing, so it does not reach anchor 5's comprehensive coverage, but it is clearly above anchor 3, whose deficiency is missing core variations.

4 / 5

Distinctiveness Conflict Risk

The REST/GraphQL API-design niche is mostly distinct with clear paradigm keywords, carrying only minor overlap risk with closely related skills such as API-documentation or general backend-development skills. The trigger 'establishing API design standards' is broad enough to collide with documentation/standards skills, so it does not earn anchor 5's 'minimal conflict risk'.

4 / 5

Total

15

/

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

wshobson/agents

Path

plugins/backend-development/skills/api-design-principles/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.