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

51%

Does it follow best practices?

Impact

Pending

No eval scenarios have been run

Securityby

Passed

No known issues

Optimize this skill with Tessl

npx tessl skill review --optimize ./docs/v19.7/configuration/agent/skills_external/antigravity-awesome-skills-main/skills/api-design-principles/SKILL.md

Quality

Discovery

67%

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 has a solid structure with an explicit 'Use when' clause that clearly defines trigger scenarios. However, it relies on marketing-style language ('delight developers') rather than concrete capabilities, and could benefit from more specific trigger terms that users naturally use when discussing API design.

Suggestions

Replace vague qualifiers ('intuitive, scalable, maintainable APIs that delight developers') with specific capabilities like 'define resource naming, versioning strategies, error handling patterns, pagination approaches'

Add more natural trigger terms users would say: 'endpoints', 'routes', 'OpenAPI', 'Swagger', 'API documentation', 'request/response schemas'

Dimension	Reasoning	Score
Specificity	Names the domain (REST and GraphQL API design) and mentions some actions (designing, reviewing, establishing standards), but uses vague qualifiers like 'intuitive, scalable, maintainable' and 'delight developers' which are abstract rather than concrete capabilities.	2 / 3
Completeness	Clearly answers both what (API design principles for REST and GraphQL) and when (designing new APIs, reviewing specifications, establishing standards) with an explicit 'Use when' clause containing specific triggers.	3 / 3
Trigger Term Quality	Includes relevant keywords like 'REST', 'GraphQL', 'API design', 'API specifications', but misses common variations users might say such as 'endpoints', 'routes', 'schema', 'OpenAPI', 'Swagger', or 'API documentation'.	2 / 3
Distinctiveness Conflict Risk	Reasonably specific to API design but could overlap with general coding skills, backend development skills, or documentation skills. The REST/GraphQL focus helps but 'API design standards' is somewhat broad.	2 / 3
	Total	9 / 12 Passed

Implementation

35%

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

This skill functions primarily as a table of contents pointing to an external playbook rather than providing actionable guidance itself. The instructions are too abstract to be useful without the referenced file, and the 'when to use' sections add bulk without value. The skill would benefit significantly from including at least one concrete example or pattern inline.

Suggestions

Add at least one concrete, executable example for REST and/or GraphQL API design (e.g., a resource naming pattern, endpoint structure, or schema snippet)

Replace the abstract 4-step instructions with specific, actionable guidance - for example, show what 'model resources' looks like with a concrete example

Remove or significantly condense the 'Use this skill when' and 'Do not use this skill when' sections - these are obvious from the skill description

Include a minimal quick-start section with one complete, copy-paste-ready pattern before deferring to the external playbook

Dimension	Reasoning	Score
Conciseness	The skill is relatively brief but includes some unnecessary content like the verbose 'Use this skill when' and 'Do not use this skill when' sections that explain obvious use cases Claude could infer. The actual instructions are lean.	2 / 3
Actionability	The instructions are extremely vague and abstract - 'Define consumers, use cases, and constraints' and 'Choose API style' provide no concrete guidance, code examples, or specific patterns. Everything actionable is deferred to an external file.	1 / 3
Workflow Clarity	There is a numbered sequence of 4 steps, but they are too high-level to be useful. No validation checkpoints, no concrete examples of what 'validate with examples' means, and no feedback loops for error recovery.	2 / 3
Progressive Disclosure	The skill appropriately references an external playbook file, but the main content is too thin - it's essentially just a pointer to another file with almost no substantive content in the skill itself. The overview lacks any quick-start value.	2 / 3
	Total	7 / 12 Passed

Validation

100%

Warnings & errors only

Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.

Validation — 11 / 11 Passed

Validation for skill structure

No warnings or errors.

Repository: duclm1x1/Dive-Ai
Commit: 20ba150

Reviewed: 27 days ago

Table of Contents

Discovery Implementation Validation

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.