CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

api-contract

Configure this skill should be used when the user asks about "API contract", "api-contract.md", "shared interface", "TypeScript interfaces", "request response schemas", "endpoint design", or needs guidance on designing contracts that coordinate backend and frontend agents. Use when building or modifying API endpoints. Trigger with phrases like 'create API', 'design endpoint', or 'API scaffold'.

Quality

79%

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 ./plugins/community/sprint/skills/api-contract/SKILL.md
SKILL.md
Quality
Evals
Security

Quality

Content

82%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 body is a strong, actionable reference: sequenced instructions, copy-paste contract templates, a practical error-handling table, and clean one-level-deep references. The only notable gaps are two unreferenced bundle files (especially the large examples.md) and a missing explicit validation step before the contract is shared.

DimensionReasoningScore

Conciseness

The body is dense and task-focused, but contains minor over-explanation of concepts Claude already knows: the prerequisite 'Familiarity with RESTful API conventions (HTTP methods, status codes, JSON schemas)' and inline comments like '# HTTP 201 Created' and '# HTTP 400 Bad Request'. This matches anchor 4 (efficient with minor trimming opportunities) rather than 5 (every token earns its place).

4 / 5

Actionability

Guidance is fully concrete and copy-paste ready: a complete '#### POST /auth/register' contract template with typed request/response blocks, a paginated list endpoint with a query-parameter table, an executable 'interface ApiError' declaration, and an Output section naming exact interfaces (User, CreateUserRequest, PaginatedResponse<T>). Specific examples cover the common cases, matching anchor 5.

5 / 5

Workflow Clarity

Six clearly sequenced instruction steps plus an Error Handling table pairing causes with solutions provide strong sequencing and remediation guidance. It falls short of anchor 5 because there is no explicit validation step (e.g. verify contract consistency) before sharing the contract in SPAWN REQUEST blocks; this matches anchor 4 (clear sequence, minor validation gaps).

4 / 5

Progressive Disclosure

Four well-signaled, one-level-deep references (${CLAUDE_SKILL_DIR}/references/writing-endpoints.md, typescript-interfaces.md, pagination.md, best-practices.md) are all real files and are restated in a Resources section with descriptions. However, two bundle files (errors.md and the 12.7 KB examples.md) are never referenced from the body, which is a minor organization gap matching anchor 4 rather than 5.

4 / 5

Total

17

/

20

Passed

Description

68%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 excels at trigger coverage with many natural, well-chosen phrases including the exact artifact file name, but it is written almost entirely as trigger guidance and never clearly states what the skill does or produces. Fixing the missing 'what' and adding a concrete action verb or two would lift it substantially.

Suggestions

Open with an explicit 'what' statement, e.g. 'Creates api-contract.md files defining request/response schemas, endpoint routes, TypeScript interfaces, and error formats shared between backend and frontend agents.'

Replace the grammatically broken opener 'Configure this skill should be used when...' with a clean third-person capability sentence followed by the 'Use when...' clause.

Narrow the broad triggers 'Use when building or modifying API endpoints' and 'create API' to contract-design contexts (e.g. 'designing or changing the shared API contract') to reduce overlap with general API implementation skills.

DimensionReasoningScore

Specificity

The description names the domain and one action-shaped phrase ("needs guidance on designing contracts that coordinate backend and frontend agents") but never states concrete actions such as creating api-contract.md files with typed request/response schemas. It matches anchor 3 (domain plus 1-2 concrete actions, not comprehensive) rather than 4, which requires a list of several specific actions.

3 / 5

Completeness

The 'when' is explicit and strong ("Use when building or modifying API endpoints", "Trigger with phrases like...") but the 'what' is only vaguely implied ("guidance on designing contracts"); the skill's actual output is never stated. This sits between anchor 2 (only 'when' without 'what') and anchor 4 (both clear), and the vague 'what' holds it at 3 rather than 4.

3 / 5

Trigger Term Quality

It quotes a comprehensive set of natural terms — "API contract", "api-contract.md", "shared interface", "TypeScript interfaces", "request response schemas", "endpoint design", "create API", "design endpoint", "API scaffold" — including synonyms and the exact file name, matching the anchor-5 example of comprehensive coverage including synonyms and file names.

5 / 5

Distinctiveness Conflict Risk

Distinct triggers like "api-contract.md" and "request response schemas" carve a clear niche, but broad phrases such as "Use when building or modifying API endpoints" and "create API" could overlap with general API-implementation skills. This matches anchor 4 (mostly distinct, minor overlap risk) rather than 5 (minimal conflict risk).

4 / 5

Total

15

/

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

frontmatter_unknown_keys

Unknown frontmatter key(s) found; consider removing or moving to metadata

Warning

Total

15

/

16

Passed

Repository

jeremylongshore/tons-of-skills-marketplace

Path

plugins/community/sprint/skills/api-contract/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.