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

68

Quality

61%

Does it follow best practices?

Impact

Pending

No eval scenarios have been run

SecuritybySnyk

Passed

No known issues

Optimize this skill with Tessl

npx tessl skill review --optimize ./plugins/community/sprint/skills/api-contract/SKILL.md
SKILL.md
Quality
Evals
Security

Quality

Discovery

72%

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 term coverage and distinctiveness, providing numerous natural phrases that would help Claude select this skill appropriately. However, it is weak on specifying what the skill actually does — it focuses heavily on when to use it but doesn't clearly articulate the concrete actions or outputs (e.g., generating interfaces, scaffolding endpoint definitions). The description also begins with 'Configure this skill should be used when' which is awkward phrasing and doesn't use proper third-person voice to describe capabilities.

Suggestions

Add a clear 'what it does' statement at the beginning using third-person voice, e.g., 'Designs and generates API contracts including TypeScript interfaces, request/response schemas, and endpoint specifications for coordinating backend and frontend agents.'

Restructure to lead with concrete capabilities before the trigger guidance — currently the description jumps straight into 'when to use' without first establishing what the skill produces.

DimensionReasoningScore

Specificity

The description mentions some actions like 'designing contracts that coordinate backend and frontend agents', 'building or modifying API endpoints', and 'create API', 'design endpoint', 'API scaffold', but it doesn't list multiple concrete specific actions the skill performs (e.g., generate TypeScript interfaces, validate schemas, etc.). It's more about when to trigger than what it concretely does.

2 / 3

Completeness

The 'when' is very well covered with explicit trigger phrases and use cases. However, the 'what does this do' is weak — it says 'guidance on designing contracts that coordinate backend and frontend agents' but doesn't clearly describe the concrete outputs or actions the skill performs. The what is implied rather than explicitly stated.

2 / 3

Trigger Term Quality

Excellent coverage of natural trigger terms: 'API contract', 'api-contract.md', 'shared interface', 'TypeScript interfaces', 'request response schemas', 'endpoint design', 'create API', 'design endpoint', 'API scaffold'. These are terms users would naturally use when needing this skill.

3 / 3

Distinctiveness Conflict Risk

The description carves out a clear niche around API contract design, TypeScript interfaces, and request/response schemas specifically for coordinating backend and frontend agents. The specific file reference 'api-contract.md' and domain-specific terms make it unlikely to conflict with general coding or documentation skills.

3 / 3

Total

10

/

12

Passed

Implementation

50%

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

This is a competent but improvable skill that provides a solid framework for API contract creation with useful examples and error handling guidance. Its main weaknesses are the lack of validation checkpoints in the workflow (important since contracts coordinate multiple agents), some verbosity in restating concepts Claude already knows, and dependence on reference files that aren't provided in the bundle. The examples section is the strongest part, giving concrete output formats.

Suggestions

Add a validation checkpoint after contract creation—e.g., a checklist to verify all endpoints from specs.md are covered, all types are referenced consistently, and no `any` types remain.

Remove the Prerequisites bullet about 'Familiarity with RESTful API conventions' and 'TypeScript knowledge'—Claude already has these. Trim the Overview to one sentence.

Either provide the referenced bundle files (writing-endpoints.md, typescript-interfaces.md, etc.) or inline the essential template content so the skill is self-contained and fully actionable.

Add a feedback loop step: after drafting the contract, cross-reference it against specs.md to ensure complete coverage before sharing with implementation agents.

DimensionReasoningScore

Conciseness

The skill is mostly efficient but includes some unnecessary content. The Overview section restates what the description already conveys, the Prerequisites list includes items Claude already knows (RESTful conventions, TypeScript knowledge), and the Output section largely repeats what the Instructions already cover. The error handling table and examples are valuable but the overall document could be tightened.

2 / 3

Actionability

The instructions provide a clear sequence of steps and the examples section includes concrete markdown/TypeScript snippets showing the expected output format. However, the actual instructions themselves are more descriptive than executable—they tell Claude what to include rather than providing copy-paste templates directly. Key templates are deferred to reference files that aren't provided in the bundle, making the skill dependent on external content for full actionability.

2 / 3

Workflow Clarity

The six steps provide a reasonable sequence for creating an API contract, and step 6 addresses coordination. However, there are no validation checkpoints—no step to verify the contract is internally consistent, no check that all endpoints from specs.md are covered, and no feedback loop for catching schema mismatches before agents consume the contract. For a document that coordinates multiple agents, this is a significant gap.

2 / 3

Progressive Disclosure

The skill references four external files in a references directory with clear descriptions in the Resources section, which is good structure. However, no bundle files were provided, so we cannot verify these references exist or contain useful content. The main body also includes substantial inline examples that partially duplicate what the reference files presumably contain, suggesting the split between overview and detail could be cleaner.

2 / 3

Total

8

/

12

Passed

Validation

90%

Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.

Validation10 / 11 Passed

Validation for skill structure

CriteriaDescriptionResult

frontmatter_unknown_keys

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

Warning

Total

10

/

11

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.