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.

70

1.13x
Quality

56%

Does it follow best practices?

Impact

94%

1.13x

Average score across 3 eval scenarios

SecuritybySnyk

Passed

No findings from the security scan

Fix and improve this skill with Tessl

tessl review fix ./tests/ext_conformance/artifacts/agents-wshobson/backend-development/skills/api-design-principles/SKILL.md

The canonical home for this skill is api-design-principles in wshobson/agents

SKILL.md
Quality
Evals
Security

Quality

Content

43%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 delivers genuinely concrete code examples, but it functions as a 500-line inlined reference manual rather than a lean SKILL.md overview: it re-teaches API basics Claude already knows and duplicates its own bundle files, while offering no design workflow. Navigation is further undermined by three referenced bundle files that do not exist.

Suggestions

Cut the SKILL.md body to a concise overview: remove explanations of basics (HTTP method semantics, REST noun/verb rules, GraphQL query/mutation roles) and replace the inline FastAPI/GraphQL/Resolver/DataLoader pattern code with links into the existing references/rest-best-practices.md and references/graphql-schema-design.md, which already cover the same material.

Fix the Resources section: remove or actually create the three nonexistent entries (references/api-versioning-strategies.md, assets/graphql-schema-template.graphql, scripts/openapi-generator.py — there is no scripts/ directory).

Add a short sequenced workflow that gives the skill a process spine, e.g. 1) draft resources/schema, 2) apply versioning and error-format decisions, 3) validate the design against assets/api-design-checklist.md, wiring the existing checklist asset into actual use.

DimensionReasoningScore

Conciseness

The body re-explains fundamentals Claude already knows — "Resources are nouns (users, orders, products), not verbs", "GET: Retrieve resources (idempotent, safe)", "Queries for reading data / Mutations for modifying data", "Clients request exactly what they need" — and then inlines ~400 lines of pattern code (FastAPI pagination endpoint, ~90-line GraphQL schema, resolvers, DataLoaders) that largely duplicates references/rest-best-practices.md and references/graphql-schema-design.md. This is noticeably verbose with several padded sections, fitting the level-2 anchor rather than the minor-trimming of level 3.

2 / 5

Actionability

The patterns are conveyed through concrete, largely executable code: a complete FastAPI paginated list endpoint, ariadne resolver implementations with cursor pagination, and DataLoader classes with batch_load_fn logic. Minor gaps keep it below level 5: helpers like fetch_users, hash_password, decode_cursor and imports like Any and ValidationError are undefined, so examples are not fully copy-paste ready.

4 / 5

Workflow Clarity

There is no sequenced design or review process at all — the body is a catalog of concepts and patterns with no ordering (no 'design the schema, then the resources, then errors, then validate against the checklist' flow) and no validation checkpoints, even though the skill's stated use cases ('reviewing API specifications', 'establishing API design standards') are process-shaped and a checklist asset exists but is never wired into a workflow. This sits below level 3, which requires at least a present step sequence.

2 / 5

Progressive Disclosure

Section headers are clear and the Resources section signals bundle files with one-line descriptions, but content that should be separate is inlined: the REST/GraphQL pattern sections duplicate the 408-line rest-best-practices.md and 583-line graphql-schema-design.md. It cannot score 4 because navigation is partially broken — 3 of the 7 listed resources do not exist (references/api-versioning-strategies.md, assets/graphql-schema-template.graphql, scripts/openapi-generator.py, and there is no scripts/ directory at all).

3 / 5

Total

11

/

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 and good natural trigger coverage for the API design domain. Its main weaknesses are an abstract 'what' ('Master... principles') that never states concrete capabilities, and buzzword padding ('delight developers').

DimensionReasoningScore

Specificity

The description names the domain ("REST and GraphQL API design principles") and gestures at 1-2 actions ("build intuitive, scalable, and maintainable APIs"), but 'master principles' is abstract rather than a concrete capability, and 'delight developers' is buzzword fluff. It does not reach level 4 because it never lists several specific concrete actions, and it clears level 2 because the domain and a build action are explicitly stated.

3 / 5

Completeness

Both parts are present: the 'what' ("Master REST and GraphQL API design principles to build... APIs") and an explicit 'when' clause ("Use when designing new APIs, reviewing API specifications, or establishing API design standards"). It falls short of level 5 because the 'what' states outcomes rather than concrete capabilities, so the pairing is not as concretely matched as the anchor example.

4 / 5

Trigger Term Quality

Natural trigger phrases like "REST", "GraphQL", "API design", "designing new APIs", "reviewing API specifications", and "establishing API design standards" match what a user would actually say. Not level 5 because common variations such as 'endpoint design', 'API guidelines', 'versioning', or 'API documentation' are absent.

4 / 5

Distinctiveness Conflict Risk

The REST/GraphQL API-design framing carves a clear niche with distinct triggers that would not fire for unrelated skills. Not level 5 because the broad trigger 'designing new APIs' could overlap with general web-development or framework-specific skills.

4 / 5

Total

15

/

20

Passed

Validation

87%

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

Validation — 14 / 16 Passed

Validation for skill structure

CriteriaDescriptionResult

skill_md_line_count

SKILL.md is long (529 lines); consider splitting into references/ and linking

Warning

referenced_paths_exist

Referenced path issues: 3 missing

Warning

Total

14

/

16

Passed

Repository
Dicklesworthstone/pi_agent_rust
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.