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 and stand the test of time.

45

Quality

56%

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 api-design-principles in rmyndharis/antigravity-skills

SKILL.md
Quality
Evals
Security

Quality

Content

46%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 well-structured and token-efficient with sensible use/anti-use sections, but it provides almost no actionable design guidance and its progressive disclosure is broken: the single referenced file does not exist and the four real bundle files are never linked. Fixing the reference path and adding concrete guidance would lift both the actionability and navigation substantially.

Suggestions

Fix the broken reference: replace 'resources/implementation-playbook.md' with the actual bundle files (references/rest-best-practices.md, references/graphql-schema-design.md, assets/api-design-checklist.md, assets/rest-api-template.py), each with a one-line description of when to consult it.

Add concrete actionable guidance to the Instructions (e.g., naming rules like 'plural nouns for resources', an error envelope example, cursor vs offset pagination guidance) instead of four abstract one-liners.

Make step 4's validation explicit — what to check (naming consistency, error coverage, auth on every endpoint) and how to iterate when the review fails — and drop the duplicated playbook pointer or the verbatim description repetition.

DimensionReasoningScore

Conciseness

The body is lean with no explanation of concepts Claude already knows, but the opening sentence duplicates the frontmatter description verbatim and the playbook pointer is stated twice (in Instructions and Resources). Not 5 because those redundancies are tokens that could be trimmed.

4 / 5

Actionability

The four instructions ('Define consumers, use cases, and constraints', 'Choose API style and model resources or types', etc.) are high-level hints with no concrete examples, naming conventions, or commands — all specifics are deferred to a reference file. Not 3 because nothing in the body itself is concretely executable; not 1 because the numbered sequence still gives minimal direction.

2 / 5

Workflow Clarity

A clear four-step sequence is present, but the only validation ('Validate with examples and review for consistency') is implicit with no checkpoints or feedback loop for how to validate or what to do on failure. Not 4 because checkpoints are missing entirely, not just minor gaps.

3 / 5

Progressive Disclosure

The only reference, 'resources/implementation-playbook.md', does not exist — there is no resources/ directory — while the four real bundle files (references/rest-best-practices.md, references/graphql-schema-design.md, assets/api-design-checklist.md, assets/rest-api-template.py) are never mentioned, leaving the actual detailed content unreachable from SKILL.md. This matches 'references are buried/broken' minimal structure; not 3 because the structure fails to navigate to any real content, which is worse than weakly-signaled but present references.

2 / 5

Total

11

/

20

Passed

Description

48%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 identifies its niche clearly but relies on aspirational, buzzword-heavy language instead of concrete capabilities, and it omits any 'when to use' trigger guidance. It would benefit from listing specific actions (e.g., design resources and endpoints, define error and versioning strategies) followed by an explicit trigger clause.

Suggestions

Replace generic claims with 2-3 concrete actions, e.g., 'Design REST resources and GraphQL schemas, define error, versioning, and pagination strategies, and review API specifications for consistency.'

Append an explicit trigger clause, e.g., 'Use when designing or refactoring REST or GraphQL APIs, writing API documentation, or reviewing API specifications.'

Cut buzzword padding ('delight developers and stand the test of time') and add natural synonyms like 'endpoints', 'OpenAPI', and 'schema design' to broaden trigger coverage.

DimensionReasoningScore

Specificity

The description names the domain ('REST and GraphQL API design') but the actions are generic ('build intuitive, scalable, and maintainable APIs') with no concrete capabilities, and it ends in buzzword fluff ('delight developers and stand the test of time'). It fits the 'names the domain but actions are minimal or generic' anchor; not 3 because no 1-2 genuinely concrete actions are listed.

2 / 5

Completeness

A clear 'what' is present (mastering REST/GraphQL API design to build APIs), but the 'when' is entirely missing — there is no 'Use when...' clause or equivalent trigger guidance, which caps completeness at 3 per the judging guidelines. Not 4 because the trigger situation is not weakly implied; it is wholly absent from the description.

3 / 5

Trigger Term Quality

'REST', 'GraphQL', and 'API design' are natural terms users would say, but common variations and synonyms (endpoints, OpenAPI/Swagger, schema design, versioning, pagination) are absent. Not 4 because keyword coverage is limited to the two paradigm names plus 'API design'.

3 / 5

Distinctiveness Conflict Risk

'REST and GraphQL API design principles' carves a mostly distinct niche with minor overlap risk against general web-development or documentation skills. Not 5 because there are no explicit distinct triggers and 'API' work could overlap with other API-related skills.

4 / 5

Total

12

/

20

Passed

Validation

93%

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

Validation — 15 / 16 Passed

Validation for skill structure

CriteriaDescriptionResult

frontmatter_unknown_keys

Unknown frontmatter key(s) found; consider removing or moving to metadata

Warning

Total

15

/

16

Passed

Repository

administrakt0r/AI-Agents-Safe-Coding-Skills

Path

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.