api-design

Patrones de diseño REST API incluyendo nomenclatura de recursos, códigos de estado, paginación, filtrado, respuestas de error, versionado y rate limiting para APIs de producción.

Quality

76%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

Securityby

High

Do not use without reviewing

Fix and improve this skill with Tessl

tessl review fix ./docs/es/skills/api-design/SKILL.md

Quality

Content

78%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 content is highly actionable and largely concise, with good internal structure and a useful design checklist. Its main weaknesses are the absence of explicit validation feedback loops and the lack of progressive disclosure into separate reference files.

Suggestions

Split large reference blocks (full TS/Python/Go implementations, status-code reference) into separate files under references/ and link to them from SKILL.md to improve progressive disclosure.

Add explicit validation/feedback-loop checkpoints for fragile operations (e.g., 'validate the error response against the standard format, fix field codes, re-check').

Trim the three full language implementations to one canonical example plus short per-language notes to reduce token load.

Dimension	Reasoning	Score
Conciseness	Mostly lean reference material with no padded concept explanations, though three full language implementations and envelope variants add length that could be trimmed slightly.	4 / 5
Actionability	Provides fully executable, copy-paste-ready code in TypeScript, Python, and Go, plus exact URL conventions, SQL, and real HTTP headers covering the common production cases.	5 / 5
Workflow Clarity	Clear 'Cuándo Activar' triggers, a sequenced versioning strategy, and a pre-publish design checklist provide verification, but there are no explicit validate→fix→retry feedback loops.	4 / 5
Progressive Disclosure	Well-organized with strong section headers, but it is a ~520-line monolithic SKILL.md with no bundle files; content like full language implementations and status-code reference could live in separate reference files.	3 / 5
	Total	16 / 20 Passed

Description

75%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 specific and distinctive with strong natural trigger terms, but it omits any explicit 'when to use' guidance, which limits its completeness. Adding a 'Use when...' clause would raise the completeness score.

Suggestions

Add an explicit 'Use when...' clause listing concrete trigger scenarios (e.g., 'Use when designing new REST endpoints, reviewing API contracts, or adding pagination/error handling').

Include common synonyms or variations of trigger terms (e.g., 'REST API', 'APIs', 'endpoints', 'HTTP') to improve natural-language matching.

Keep the concise enumeration of design areas, but pair it with the trigger guidance so both 'what' and 'when' are answered.

Dimension	Reasoning	Score
Specificity	Names the REST API domain and lists seven concrete design areas (nomenclatura de recursos, códigos de estado, paginación, filtrado, respuestas de error, versionado, rate limiting), giving comprehensive coverage of specific actions.	5 / 5
Completeness	The 'what' is clearly stated, but there is no 'Use when...' clause or equivalent explicit trigger guidance, which caps completeness at 3 per the judging guidelines.	3 / 5
Trigger Term Quality	Includes natural developer terms like 'REST API', 'paginación', 'filtrado', 'versionado', and 'rate limiting', but lacks common synonyms and language variations that would warrant a 5.	4 / 5
Distinctiveness Conflict Risk	Occupies a clear, specific niche (production REST API design patterns) with distinct trigger areas and minimal overlap risk against unrelated skills.	5 / 5
	Total	17 / 20 Passed

Validation

87%

Warnings & errors only

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

Criteria	Description	Result
skill_md_line_count	SKILL.md is long (524 lines); consider splitting into references/ and linking	Warning
frontmatter_unknown_keys	Unknown frontmatter key(s) found; consider removing or moving to metadata	Warning

	Total	14 / 16 Passed

Repository: affaan-m/ECC
Path: docs/es/skills/api-design/SKILL.md
Commit: d8409a4

Reviewed: 1 day ago

Table of Contents

Discovery Implementation Validation

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.