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

70

Quality

Does it follow best practices?

Impact

No eval scenarios have been run

SecuritybySnyk

Passed

No known issues

SKILL.md
Quality
Evals
Security

Quality

Content

72%

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

The content is actionable and well-structured with clean progressive disclosure to four real reference files, but it is somewhat verbose because inline examples repeat reference material, and the workflow lacks an explicit validation/feedback checkpoint despite being a multi-step authoring process.

Suggestions

Add an explicit validation step to the workflow, e.g., after authoring the contract verify that every endpoint has request, response, and error definitions and that shared types are referenced rather than duplicated.

Trim the inline pagination and endpoint examples in SKILL.md since the same content appears in pagination.md and writing-endpoints.md, keeping the body as an overview that points out.

Either reference the existing errors.md and examples.md bundle files in the Resources list or remove them, so the bundled files all have clear navigation from the skill body.

DimensionReasoningScore

Conciseness

The body is mostly efficient and assumes Claude's knowledge (no padding explaining REST or TypeScript), but the Prerequisites, Overview, and large inline endpoint/pagination examples duplicate material that already lives in the referenced files, so it could be tightened.

2 / 3

Actionability

Instructions are concrete and copy-ready: numbered steps with explicit file paths, specific field constraints ('string, required, valid email format'), the PaginatedResponse<T> wrapper, and full endpoint examples, matching the executable-and-specific anchor.

3 / 3

Workflow Clarity

The six numbered steps give a clear sequence, but there is no explicit validation checkpoint or feedback loop (e.g., 'confirm both agents reference the contract' or 'verify the contract is internally consistent'); the Error Handling table offers recovery hints but checkpoints are implicit.

2 / 3

Progressive Disclosure

The body is a clear overview pointing to four real one-level-deep references (writing-endpoints.md, typescript-interfaces.md, pagination.md, best-practices.md), each signposted in the Resources section with a descriptive label and a ${CLAUDE_SKILL_DIR}/references/ path, so navigation is easy.

3 / 3

Total

10

/

12

Passed

Description

100%

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 across all dimensions: it names concrete capabilities, includes explicit natural trigger terms, and clearly states both what it does and when to use it. The only blemish is a grammatically awkward opening ('Configure this skill should be used when...') that does not materially affect scoring.

DimensionReasoningScore

Specificity

The description lists multiple concrete actions: 'Define... request/response schemas, endpoint routes, TypeScript interfaces, and error formats' and 'building or modifying API endpoints', matching the anchor for listing multiple specific concrete actions.

3 / 3

Completeness

It answers both 'what' (defines schemas, routes, interfaces, error formats to coordinate backend and frontend agents) and 'when' with an explicit 'Use when building or modifying API endpoints' plus 'Trigger with phrases like' clause, satisfying the what-AND-when anchor.

3 / 3

Trigger Term Quality

It covers natural terms a user would say — 'API contract', 'api-contract.md', 'shared interface', 'TypeScript interfaces', 'endpoint design', plus explicit 'create API', 'design endpoint', 'API scaffold' triggers — giving good coverage of natural phrasings.

3 / 3

Distinctiveness Conflict Risk

The niche is distinct — coordinating a shared api-contract.md between backend and frontend agents during sprints — and the trigger phrases are specific enough to avoid firing for unrelated skills, matching the clear-niche anchor.

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.