CtrlK
BlogDocsLog inGet started
Tessl Logo

generating-api-contracts

Generate API contracts and OpenAPI specifications from code or design documents. Use when documenting API contracts and specifications. Trigger with phrases like "generate API contract", "create OpenAPI spec", or "document API contract".

69

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.

A well-organized, concise skill body that uses progressive disclosure effectively with real reference files. Its main weaknesses are the absence of inline executable code/artifacts and missing validation checkpoints woven into the workflow sequence.

Suggestions

Add at least one concrete, copy-paste OpenAPI YAML snippet or a sample Pact interaction inline in the Instructions or Examples section to lift actionability.

Insert an explicit validation checkpoint into the workflow — e.g., a step that runs Spectral linting against the generated spec and only proceeds on success — to create a validate-fix-retry feedback loop.

Tie the Error Handling table entries back to the workflow steps they address so recovery guidance is reachable at the point of failure rather than only in a separate section.

DimensionReasoningScore

Conciseness

The body is lean and assumes Claude's competence — it never explains what OpenAPI or Pact is, and each section (Prerequisites, Instructions, Output, Error Handling) earns its place without padding.

3 / 3

Actionability

Steps are specific (named schema fields like type/format/required, status codes 200/400/401, security schemes bearerAuth/oauth2) but no inline executable code or concrete OpenAPI/Pact snippets are given; actionable guidance is present yet incomplete for copy-paste use.

2 / 3

Workflow Clarity

Eight clearly sequenced steps are listed, but there are no inline validation checkpoints (e.g., a Spectral lint step) within the workflow; error handling is split into a separate table rather than woven as feedback loops, capping this at 2 for a batch-style operation.

2 / 3

Progressive Disclosure

Clear overview with well-signaled one-level-deep references — implementation.md, errors.md, examples.md, and scripts/generate-contract.sh — each introduced with its purpose, and all referenced files exist in the bundle.

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.

A strong, well-structured description that names concrete actions, supplies natural trigger phrases, and answers both what the skill does and when to use it. It occupies a distinct niche with low conflict risk.

DimensionReasoningScore

Specificity

Lists multiple concrete actions — 'Generate API contracts and OpenAPI specifications from code or design documents' — naming the domain and the source artifacts rather than vague language.

3 / 3

Completeness

Explicitly answers both 'what' (generate API contracts/OpenAPI specs from code or design documents) and 'when' ('Use when documenting API contracts and specifications' plus trigger phrases).

3 / 3

Trigger Term Quality

Provides natural trigger phrases users would say — 'generate API contract', 'create OpenAPI spec', 'document API contract' — alongside a 'Use when' clause, giving good coverage.

3 / 3

Distinctiveness Conflict Risk

Targets a clear niche — API contracts and OpenAPI specifications — with distinct triggers unlikely to collide with general-purpose skills.

3 / 3

Total

12

/

12

Passed

Validation

87%

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

Validation14 / 16 Passed

Validation for skill structure

CriteriaDescriptionResult

allowed_tools_field

'allowed-tools' contains unusual tool name(s)

Warning

frontmatter_unknown_keys

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

Warning

Total

14

/

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.