CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

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.

56

Quality

70%

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

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 skill has an excellent explicit review workflow with validation gates and feedback loops, but the body is a monolithic REST textbook that re-teaches knowledge Claude already has, and its only file references point to scripts missing from the bundle. Cutting the reference material and shipping the actual scripts would transform its usefulness.

Suggestions

Cut the REST textbook sections (HTTP methods, status codes, auth patterns, pagination, HATEOAS, idempotency, caching, security lists, best-practices/anti-patterns summaries) that restate knowledge Claude already has; keep only the team-specific conventions and scorecard weights that differ from defaults.

Ship the referenced scripts in a scripts/ directory (or document their exact checks, outputs, and flags inline), since Quick Start, CI/CD, and pre-commit examples all invoke files that do not exist in the bundle.

Move any retained reference material (versioning strategies, error format, backward-compatibility lists) into a single references/ file linked from a short overview, so SKILL.md stays a lean workflow pointer rather than a 430-line document.

DimensionReasoningScore

Conciseness

Roughly 90% of the ~430-line body extensively explains concepts Claude already knows: HTTP method semantics, status-code meanings, auth header examples, RBAC JSON, HATEOAS, idempotency, pagination payload shapes, cache headers, and generic security/best-practice lists. This is far beyond 'several unnecessary explanations'; the genuinely additive content (three commands and the review flow) occupies about 40 lines.

1 / 5

Actionability

The Quick Start gives concrete commands with gate flags and the review flow is directive, but the three referenced scripts do not exist in the bundle and the tools' outputs, checks, and flag behavior beyond the two gates are undocumented, so the guidance is concrete yet incomplete.

3 / 5

Workflow Clarity

The review flow is an explicit sequence with validation gates ('--exit-on-breaking', '--min-grade'), a fix-and-re-run feedback loop, a reporting step, and a hard rule to never sign off without tool outputs.

5 / 5

Progressive Disclosure

The only references point to scripts/api_linter.py, scripts/breaking_change_detector.py, and scripts/api_scorecard.py, none of which exist in the bundle, while ~380 lines of REST reference material that clearly belongs in separate files (or nowhere, since Claude already knows it) are inlined in SKILL.md.

2 / 5

Total

11

/

20

Passed

Description

83%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 strong description with concrete capabilities, explicit trigger guidance, and a well-defined niche. Its main weaknesses are the omission of the input format (OpenAPI/Swagger specs) as both a capability detail and a trigger term, plus slight overlap with general code-review triggers.

DimensionReasoningScore

Specificity

Names several concrete actions ('automated linting, breaking-change detection, and design scorecards', 'Catches inconsistent conventions, missing versioning, and design smells') but never states what artifact it operates on (OpenAPI/Swagger specs), leaving a minor coverage gap below the comprehensive anchor.

4 / 5

Completeness

Explicitly answers both what (linting, breaking-change detection, design scorecards, catching conventions/versioning/design smells) and when, via a 'Use when...' clause with three concrete trigger scenarios.

5 / 5

Trigger Term Quality

'reviewing a PR that adds or changes API endpoints', 'auditing an existing API for v2 migration', and 'establishing API standards for a team' are natural user phrases, but common synonyms like OpenAPI, Swagger, spec, or REST are missing, short of comprehensive coverage.

4 / 5

Distinctiveness Conflict Risk

The REST API design niche is clear and triggers are specific, but 'reviewing a PR that adds or changes API endpoints' competes with general code-review skills on the same natural query, creating minor overlap with a closely related skill.

4 / 5

Total

17

/

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

referenced_paths_exist

Referenced path issues: 6 missing

Warning

Total

15

/

16

Passed

Repository

alirezarezvani/claude-skills

Path

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