CtrlK
BlogDocsLog inGet started
Tessl Logo

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.

60

Quality

70%

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

Quality

Content

57%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, code-rich reference for API design that is mostly actionable but over-long for a single SKILL.md. It would benefit from trimming basic-concept explanation and splitting the pattern catalogs into reference files.

Suggestions

Trim the Core Concepts section's basic HTTP-method and noun/verb explanations that Claude already knows; keep only design-decision guidance that adds new information.

Split the REST and GraphQL pattern catalogs into reference files (e.g. references/rest-patterns.md, references/graphql-patterns.md) and summarize them in SKILL.md with one-level-deep links.

Make the pagination example fully executable by either defining build_query/count_users/fetch_users or replacing them with real inline queries so the example is copy-paste ready.

DimensionReasoningScore

Conciseness

The Core Concepts section re-explains basic HTTP method semantics and REST nouns-vs-verbs that Claude already knows, and the Best Practices lists are largely common knowledge, though the code-driven pattern sections earn their tokens.

3 / 5

Actionability

Provides mostly executable FastAPI and GraphQL schema examples, but the pagination example relies on undefined stubs (build_query, count_users, fetch_users) preventing fully copy-paste-ready use.

4 / 5

Workflow Clarity

This is a patterns/reference skill with no multi-step process or validation checkpoints; sequence is implicit rather than laid out, so it sits at the midpoint for workflow clarity.

3 / 5

Progressive Disclosure

The 263-line body inlines REST patterns, GraphQL patterns, and best-practice lists that could live in separate reference files, and there are no external references or bundle files to offload detail.

3 / 5

Total

13

/

20

Passed

Description

82%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 that clearly states both purpose and trigger conditions with concrete 'Use when' phrasing. The main weakness is that the listed actions are somewhat abstract use cases rather than sharply concrete capabilities.

DimensionReasoningScore

Specificity

Names the domain (REST and GraphQL APIs) and lists 'designing new APIs, reviewing API specifications, establishing API design standards', but these are high-level use cases rather than concrete, distinct capabilities, so it stops short of comprehensive coverage.

3 / 5

Completeness

Explicitly answers both 'what' ('Master REST and GraphQL API design principles to build... APIs') and 'when' with concrete trigger phrases in the 'Use when designing new APIs, reviewing API specifications, or establishing API design standards' clause.

5 / 5

Trigger Term Quality

Includes natural terms users would say ('REST', 'GraphQL', 'API design', 'API specifications', 'designing APIs') with good coverage, though a few synonyms and casual phrasings are missing.

4 / 5

Distinctiveness Conflict Risk

Occupies a clear API-design niche with distinct triggers (REST/GraphQL design, spec review, design standards) and minimal overlap with unrelated skills.

5 / 5

Total

17

/

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.

Validation16 / 16 Passed

Validation for skill structure

No warnings or errors.

Repository
secondsky/claude-skills
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.