CtrlK
BlogDocsLog inGet started
Tessl Logo

api-design-reviewer

Comprehensive REST API design review with automated linting, breaking-change detection, and design scorecards. Catches inconsistent conventions, missing versioning, and design smells before APIs ship. Use when reviewing a PR that adds or changes API endpoints, auditing an existing API for v2 migration, or establishing API standards for a team.

57

Quality

66%

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

The canonical home for this skill is api-design-reviewer in alirezarezvani/claude-skills

SKILL.md
Quality
Evals
Security

Quality

Content

45%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 dominated by generic REST reference material Claude already knows, buried in a single monolithic file with no progressive disclosure to detail files. The skill-specific value — three executable tools and a re-run-until-clean review flow — is present and concrete but accounts for a small fraction of the token budget.

Suggestions

Strip the generic REST tutorial sections (HTTP methods, status codes, pagination/auth/error JSON, HATEOAS, idempotency, backward-compat, security best-practices, anti-patterns) — Claude already knows this; keep only the tool invocations, the review flow, and skill-specific scoring rules.

Move the bulk of the reference material into one-level-deep files (e.g. references/rest-conventions.md, references/breaking-changes.md) and replace the inlined content with clearly signaled links, so SKILL.md becomes a concise overview.

Either bundle the referenced scripts/api_linter.py, breaking_change_detector.py, and api_scorecard.py so the commands actually run, or remove the script invocations and describe the review procedure without referencing files that are absent.

DimensionReasoningScore

Conciseness

The ~430-line body extensively explains REST concepts Claude already knows — HTTP method semantics, status code lists, pagination JSON, auth header formats, HATEOAS, idempotency, backward-compatibility lists, security best-practices, and anti-patterns — leaving only the Quick Start and Tools sections as skill-specific, which matches the 'severely verbose; heavily padded' score-1 anchor.

1 / 5

Actionability

Quick Start provides copy-paste-ready commands with flags for all three tools ('python3 scripts/api_linter.py openapi.json --format json -o lint.json', etc.) and CI/CD plus pre-commit examples, but the Tools section lists features rather than full CLI usage and the referenced scripts are not bundled, leaving minor gaps below the score-5 anchor.

4 / 5

Workflow Clarity

The review flow has an explicit feedback loop — 'run all three, report... fix, then re-run until the linter is clean, --exit-on-breaking passes... and the scorecard meets the agreed --min-grade' — with gating checkpoints, but it is written in prose rather than a crisp numbered sequence with per-step validation, sitting at the score-4 anchor.

4 / 5

Progressive Disclosure

SKILL.md is a monolithic 430-line reference manual with no bundle files; material that clearly belongs in separate files (REST principles, pagination, auth, error formats) is inlined, and the referenced scripts/*.py do not exist, matching the score-2 anchor where content that belongs in separate files is inlined.

2 / 5

Total

11

/

20

Passed

Description

88%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 is strong: it concisely states concrete capabilities and gives explicit, natural-sounding trigger conditions for when to use the skill. The only gaps are the absence of format-specific keywords (OpenAPI/Swagger/spec files) and minor overlap with general code-review skills.

DimensionReasoningScore

Specificity

Lists multiple concrete actions — 'automated linting, breaking-change detection, and design scorecards' and 'Catches inconsistent conventions, missing versioning, and design smells' — giving comprehensive coverage of the skill's capabilities, matching the score-5 anchor.

5 / 5

Completeness

Explicitly answers both what ('Comprehensive REST API design review with automated linting, breaking-change detection, and design scorecards') and when ('Use when reviewing a PR... auditing an existing API for v2 migration, or establishing API standards'), matching the score-5 anchor with concrete trigger phrases.

5 / 5

Trigger Term Quality

Strong natural trigger phrases ('reviewing a PR that adds or changes API endpoints', 'auditing an existing API for v2 migration', 'establishing API standards') with synonyms, but missing format-specific terms a user would naturally say such as OpenAPI, Swagger, or .yaml/.json spec files, so it sits just below the score-5 anchor.

4 / 5

Distinctiveness Conflict Risk

Has a clear API-design niche with distinct triggers, but 'reviewing a PR that adds or changes API endpoints' carries minor overlap risk with a generic PR/code-review skill, placing it at the score-4 anchor rather than 5.

4 / 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.

Validation15 / 16 Passed

Validation for skill structure

CriteriaDescriptionResult

referenced_paths_exist

Referenced path issues: 6 missing

Warning

Total

15

/

16

Passed

Repository
alirezarezvani/claude-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.