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

The canonical home for this skill is jbvc/api-design-principles

SKILL.md
Quality
Evals
Security

Quality

Content

50%

Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.

The body is reasonably organized and sequenced but stays at a high level of abstraction, with no concrete patterns or examples and no valid path to the detailed materials that actually exist in the bundle. The reference to a missing `resources/implementation-playbook.md` while ignoring the real reference/asset files is the most actionable defect.

Suggestions

Fix the broken reference: point to the real bundle files, e.g. 'See references/rest-best-practices.md and references/graphql-schema-design.md for patterns; assets/api-design-checklist.md for a review checklist; assets/rest-api-template.py for a starter template.'

Move concrete detail into the body or the referenced files — add at least one concrete example (e.g. a sample resource route or GraphQL type) so step 2 is actionable rather than abstract.

Add an explicit validation checkpoint with a feedback loop (e.g. 'Run through assets/api-design-checklist.md; fix gaps and re-check before finalizing').

DimensionReasoningScore

Conciseness

The body is short and sectioned, but the opening line restates the frontmatter description almost verbatim and adds fluff ('stand the test of time'), and the Use/Don't-use sections restate the description's triggers — mostly efficient but could be tightened.

2 / 3

Actionability

The four numbered steps name concrete sub-topics (errors, versioning, pagination, auth) but give no specific patterns, examples, or commands — concrete guidance is incomplete and offloaded to a reference that does not exist.

2 / 3

Workflow Clarity

Steps are clearly sequenced and step 4 mentions validation ('Validate with examples and review for consistency'), but there are no explicit checkpoints, feedback loops, or error-recovery guidance, matching the 'steps listed but checkpoints missing or implicit' anchor.

2 / 3

Progressive Disclosure

The body has reasonable section structure, but its only reference — `resources/implementation-playbook.md` — points to a nonexistent path, while the four real bundle files (references/graphql-schema-design.md, references/rest-best-practices.md, assets/api-design-checklist.md, assets/rest-api-template.py) are never surfaced, so navigation to the detailed materials fails.

2 / 3

Total

8

/

12

Passed

Description

90%

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: it cleanly answers both what and when with an explicit Use-when clause and natural, distinctive trigger terms. The only weak spot is specificity, where a single abstract action with adjective padding ("intuitive, scalable, and maintainable... delight developers") replaces a list of concrete capabilities.

Suggestions

Replace the abstract 'build intuitive, scalable, and maintainable APIs that delight developers' with concrete actions, e.g. 'Model resources and GraphQL types, define errors, versioning, pagination, and auth strategies, and review API specs for consistency.'

Trim buzzword padding ('delight developers') which adds no triggering value.

DimensionReasoningScore

Specificity

It names the domain ("REST and GraphQL API design") and a general action ("build intuitive, scalable, and maintainable APIs"), but offers one abstract action padded with adjectives rather than multiple concrete actions, matching the 'names domain and some actions, but not comprehensive' anchor.

2 / 3

Completeness

It states what the skill does ("Master REST and GraphQL API design principles to build... APIs") and includes an explicit "Use when..." trigger clause, satisfying both the what and the when.

3 / 3

Trigger Term Quality

Natural terms a user would say are well covered — "REST", "GraphQL", "API", "API specifications", "API design standards" — alongside scenario triggers like designing, reviewing, and establishing standards.

3 / 3

Distinctiveness Conflict Risk

It carves a clear niche (REST/GraphQL API design) with distinct triggers unlikely to fire for unrelated skills.

3 / 3

Total

11

/

12

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
rmyndharis/antigravity-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.