CtrlK
BlogDocsLog inGet started
Tessl Logo

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'.

75

Quality

93%

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

87%Weight 40%Scale 1-3

Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.

The content is concise, actionable, and well-structured with appropriate progressive disclosure through clearly signaled reference files. The main gap is the absence of an explicit validation/review checkpoint in the workflow to confirm the contract is complete and consistent before it is shared with backend and frontend agents.

Suggestions

Add a final validation step to the Instructions (e.g., 'Before sharing, verify every endpoint documents all status codes, references shared types instead of duplicating them, and that request/response schemas match the TypeScript interfaces') to create a feedback loop.

Cross-reference the existing errors.md and examples.md bundle files in the body or Resources section — they are present but never mentioned, so a reader has no signal they exist.

DimensionReasoningScore

Conciseness

The body is lean and assumes Claude's competence — it does not explain REST, HTTP status codes, or TypeScript basics, and every section earns its place.

3 / 3

Actionability

Provides concrete numbered steps, real endpoint templates with typed request/response schemas, a TypeScript interface example, and a working pagination query-parameter table — copy-paste ready.

3 / 3

Workflow Clarity

The six instructions are clearly sequenced, but there is no validation or verification checkpoint confirming the contract is complete and internally consistent before sharing it, capping it at 2 per the missing-feedback-loop guideline.

2 / 3

Progressive Disclosure

The SKILL.md is a concise overview with well-signaled one-level-deep references to six real bundle files (writing-endpoints.md, typescript-interfaces.md, pagination.md, best-practices.md, examples.md, errors.md), each mapped to a specific purpose in the Resources section.

3 / 3

Total

11

/

12

Passed

Description

100%Weight 40%Scale 1-3

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, well-triggered, and distinct, clearly stating both what the skill produces and when to invoke it. The only weakness is the grammatically mangled opening phrase 'Configure this skill should be used when', which reads awkwardly but does not undermine its functional clarity.

Suggestions

Fix the opening grammar: replace 'Configure this skill should be used when...' with a clean third-person statement such as 'Use this skill when...'.

Tighten the duplicated trigger phrasing ('should be used when' and 'Use when' and 'Trigger with') into a single concise 'Use when...' clause.

DimensionReasoningScore

Specificity

Lists multiple concrete actions — 'guides the creation of api-contract.md files', 'defines request/response schemas, endpoint routes, TypeScript interfaces, and error formats' — matching the level-3 anchor.

3 / 3

Completeness

Answers both what (creates api-contract.md defining schemas, routes, interfaces, errors) and when ('Use when building or modifying API endpoints') with explicit triggers, satisfying the level-3 anchor.

3 / 3

Trigger Term Quality

Strong natural coverage including 'API contract', 'api-contract.md', 'shared interface', 'TypeScript interfaces', 'create API', 'design endpoint', and 'API scaffold' — terms a user would plausibly say.

3 / 3

Distinctiveness Conflict Risk

Targets a clear niche (the api-contract.md shared interface between backend and frontend agents) with distinct triggers, making conflict with other skills unlikely.

3 / 3

Total

12

/

12

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

frontmatter_unknown_keys

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

Warning

Total

15

/

16

Passed

Repository
jeremylongshore/claude-code-plugins-plus-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.