CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

api-design-review

Review or design an API contract: REST, GraphQL, gRPC, events, webhooks, streaming, or OpenAPI/AsyncAPI. Use when the primary deliverable is an interface contract, compatibility assessment, or API-specific security/resilience guidance. Do not use for whole-system architecture planning, generic code review, database modeling, or implementation debugging.

Quality

88%

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

SKILL.md
Quality
Evals
Security

Quality

Content

85%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 strong, expert-level review skill: dense actionable guidance, a well-sequenced workflow with explicit evidence and validation gates, and an exact output contract. The main defect is structural: the body depends on ten referenced policy/contract files that are absent from the bundle, and it never mentions the bundled validate_scenarios.py script, which hurts navigation despite the otherwise clean reference layout.

Suggestions

Fix the broken required references: either include the shared/base/* policy files and shared/workflow-contract.md in the bundle or remove the 'Required packaged policies' and workflow-contract links, since a reader following them today hits missing files.

Reference scripts/validate_scenarios.py from the workflow (e.g., in step 6 or the Tools section) or remove it, so every bundled file is reachable from SKILL.md.

Trim the framework boilerplate (Base Framework precedence rules, Optional Workflow Integration) and the Routing Boundary section that repeats the description's exclusions to tighten the token budget.

DimensionReasoningScore

Conciseness

The core guidance is dense and information-bearing with almost no re-teaching of known concepts (e.g., 'use RFC 7807 Problem Details for REST where appropriate' is a pointer, not a tutorial). Not 5 because two framework-boilerplate sections (Base Framework policy links, Optional Workflow Integration) and a Routing Boundary section that repeats the description's exclusions consume roughly 15% of the body without adding API-specific value; not 3 because beyond that boilerplate nearly every token earns its place.

4 / 5

Actionability

For an instruction-only skill the guidance is highly concrete: an exact output-contract template ('Use this exact structure... Write **Not assessed - evidence needed: ...**'), specific review traces ('credential -> identity -> scope/role -> tenant -> resource ownership -> response fields'), named vulnerability classes (BOLA/IDOR, mass assignment), named tools (Spectral, Schemathesis, k6), specific headers (Cache-Control, ETag, Vary), and three worked example scenarios covering common cases. Not 4 because no key execution detail is missing for a review skill — the examples and checklists are copy-paste usable.

5 / 5

Workflow Clarity

A clearly sequenced six-step workflow (purpose/budgets -> style selection -> contract review -> security/tenancy -> reliability/scale -> version/validate/release) with explicit checkpoints: mandatory evidence/confidence labels (Verified/Likely/Assumption/Unknown), 'Test negative cases', 'Measure before recommending performance changes', a closing quality checklist, and validation gates in step 6 (contract tests, lint/spec-validate, fuzz, negative authorization tests, canary). This is a review skill, so the destructive/batch feedback-loop cap does not apply.

5 / 5

Progressive Disclosure

The three real reference files (references/protocols-and-async.md, references/rest-and-openapi.md, references/security-and-resilience.md) exist, are one level deep, and are clearly signaled inline. However, the Base Framework section marks nine 'Required packaged policies' at shared/base/*.md plus shared/workflow-contract.md, none of which exist in the bundle — ten dead paths — and scripts/validate_scenarios.py sits in the bundle unreferenced by the body. Not 4 because broken required references plus an orphaned script file are more than minor organization gaps; not 2 because the actual reference split and signaling of the files that do exist is well done.

3 / 5

Total

17

/

20

Passed

Description

87%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 well-crafted description: concrete domain enumeration, an explicit 'Use when' clause, and strong negative boundary guidance that separates it from architecture, code-review, database, and debugging skills. Voice is third-person/imperative as the good examples model. Minor headroom only in synonym coverage (e.g., 'Swagger', 'endpoints').

DimensionReasoningScore

Specificity

The description lists several concrete actions — 'Review or design an API contract', 'compatibility assessment', 'API-specific security/resilience guidance' — and covers the full protocol domain (REST, GraphQL, gRPC, events, webhooks, streaming, OpenAPI/AsyncAPI). Not 5 because the verbs remain high-level (review/design) rather than enumerating concrete tasks the way the top anchor's example does; not 3 because multiple actions plus full domain coverage exceed the 1–2 action bar.

4 / 5

Completeness

Both questions are answered explicitly: what ('Review or design an API contract: REST, GraphQL, gRPC, events, webhooks, streaming, or OpenAPI/AsyncAPI') and when ('Use when the primary deliverable is an interface contract, compatibility assessment, or API-specific security/resilience guidance'), plus negative boundary guidance ('Do not use for whole-system architecture planning, generic code review, database modeling, or implementation debugging'). Matches the anchor-5 example structure of concrete what + explicit when.

5 / 5

Trigger Term Quality

Natural terms users would say are present: 'review API', 'design an API contract', protocol names (REST, GraphQL, gRPC, webhooks, OpenAPI/AsyncAPI), 'compatibility', 'security/resilience'. Not 5 because common synonyms like 'Swagger', 'endpoints', or 'API audit' phrasing (only 'audit'-adjacent terms appear) have partial coverage; not 3 because coverage clearly goes beyond a couple of generic keywords.

4 / 5

Distinctiveness Conflict Risk

It carves a clear niche (API/interface contracts) and explicitly disambiguates adjacent skills ('Do not use for whole-system architecture planning, generic code review, database modeling, or implementation debugging'), which minimizes wrong-skill triggering. Not 4 because the exclusion list removes nearly all overlap risk with the most confusable neighbors.

5 / 5

Total

18

/

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

relative_links

Relative link issues: 10 missing, 9 deeper-than-1-level

Warning

Total

15

/

16

Passed

Repository

Noorkhalel/saas-ai-skills

Path

skills/api-design-review/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.