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.

49

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 functions as a textbook summary of API design knowledge Claude largely already has, with principles and pitfall lists instead of instructive guidance, and no workflow or validation checkpoints. Its one redeeming structural feature — a clearly signaled pointer to references/details.md — is undermined by four of five bundle files being orphaned and unreachable from the skill's navigation.

Suggestions

Replace the 'Core Concepts' and 'Best Practices' sections (which restate knowledge Claude already has) with a compact set of prescriptive rules and 2-3 worked good/bad endpoint examples, moving the tutorial-style material into the references files.

Add a step-by-step workflow for the skill's main use cases — e.g., designing an API (draft resources -> apply naming/versioning rules -> validate against the checklist in assets/api-design-checklist.md) or reviewing a spec — with explicit checkpoints.

Link every bundle file from SKILL.md: surface references/graphql-schema-design.md, references/rest-best-practices.md, assets/api-design-checklist.md, and assets/rest-api-template.py in the navigation section alongside references/details.md so they are discoverable.

DimensionReasoningScore

Conciseness

Large stretches re-teach concepts Claude already knows: HTTP method semantics ('GET: Retrieve resources (idempotent, safe)'), REST basics, and generic best-practice lists ('Stateless: Each request contains all necessary information', 'Poor Documentation: Undocumented APIs frustrate developers'). Not a 3: the padding is not incidental — the Core Concepts and Best Practices sections are almost entirely redundant with Claude's built-in knowledge. Not a 1: it is organized into scannable lists rather than verbose prose paragraphs.

2 / 5

Actionability

Scattered concrete micro-guidance exists ('Use plural nouns for collections (/users, not /user)', 'Accept: application/vnd.api+json; version=1', 'Use DataLoaders', 'cursor-based pagination (Relay spec)'), but the body contains no worked examples, endpoint design patterns, or executable code — those all live in references/details.md and the orphaned bundle files. Not a 4: an engineer reading only SKILL.md could not execute an API review or design; the specifics are hints, not instructive examples. Not a 2: the URL/versioning snippets and named conventions do give some directly usable direction.

3 / 5

Workflow Clarity

There is no multi-step process anywhere: no sequence for designing an API, reviewing a specification, or applying the checklist, and no validation checkpoints (e.g., 'review against assets/api-design-checklist.md before finalizing'). Not a 1: content is coherently organized by topic and a usage-trigger section exists. Not a 3: not even an implicit step sequence or checkpoint exists to have gaps in.

2 / 5

Progressive Disclosure

The pointer to references/details.md is well signaled ('Read that file when the navigation tier above is insufficient') and one level deep — but of the five bundle files, four (references/graphql-schema-design.md, references/rest-best-practices.md, assets/api-design-checklist.md, assets/rest-api-template.py) are never mentioned in SKILL.md or in details.md, making them undiscoverable. Not a 4: orphaning most of the bundle is more than a 'minor organization gap'. Not a 2: the SKILL.md/references split itself is respected and the one reference that is given is clear, not buried.

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.

A solid description with an explicit 'Use when' clause, natural trigger terms, and a distinct REST/GraphQL niche. The main weakness is a buzzword-heavy what-clause ('delight developers', 'intuitive, scalable, maintainable') that pads without adding concrete capability, and a trigger list that omits scenarios the skill body itself claims to cover (refactoring, paradigm migration, documentation).

DimensionReasoningScore

Specificity

The description names the domain ("REST and GraphQL API design principles") and a few actions ("designing new APIs, reviewing API specifications, or establishing API design standards"), but the what-clause itself leans on adjectives ("intuitive, scalable, and maintainable APIs that delight developers") rather than concrete capabilities. Not a 4: no enumeration of specific concrete actions comparable to 'extracts text, fills forms, merges documents'. Not a 2: it goes beyond naming the domain by listing design/review/standards activities.

3 / 5

Completeness

Both parts are explicit: what ("Master REST and GraphQL API design principles to build... APIs") and when ("Use when designing new APIs, reviewing API specifications, or establishing API design standards"). Not a 5: the 'when' covers only three triggers and omits scenarios the body itself targets (refactoring APIs, REST-to-GraphQL migration, API documentation). Not a 3: the 'when' clause is explicit, not merely implied.

4 / 5

Trigger Term Quality

Natural terms users would say are present: "designing new APIs", "REST", "GraphQL", "API specifications", "API design standards". Not a 5: misses common variations and artifacts users would mention, such as 'endpoints', 'OpenAPI', 'Swagger', 'schema design', or 'API review'. Not a 3: coverage is good, not merely 'some relevant keywords'.

4 / 5

Distinctiveness Conflict Risk

"REST and GraphQL API design" carves a clear niche with distinct trigger phrases; conflict risk is limited to closely related skills (e.g., generic backend-development or documentation skills). Not a 5: 'API design standards' and 'reviewing API specifications' could plausibly overlap with documentation/standards skills. Not a 3: the REST/GraphQL framing is specific enough that mis-triggering is unlikely.

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.