CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

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

Quality

81%

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

78%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.

A strong, well-structured skill body: specific actionable steps, a useful error-cause-solution table, and exemplary progressive disclosure with real one-level-deep reference files. The main improvements are embedding an explicit spec-validation step in the workflow and adding one or two concrete commands (Spectral lint, script invocation).

DimensionReasoningScore

Conciseness

The body is efficient and assumes Claude's knowledge (no explanations of what OpenAPI or Pact are), with only minor trimmable parentheticals ('(bearerAuth, apiKey, oauth2)', 'e.g., getUsers, createUser') and slight puffery in the Overview ('single source of truth for code generation, documentation, testing, and gateway configuration'). It is noticeably above the 'mostly efficient but includes some unnecessary explanation' of anchor 3 but not every token earns its place as anchor 5 requires.

4 / 5

Actionability

Guidance is mostly executable and specific: exact schema fields to define (type, format, required, minimum/maximum, pattern, enum, example), a concrete status-code taxonomy per endpoint, deterministic operationId examples, and concrete output paths via ${CLAUDE_SKILL_DIR}. It falls short of anchor 5 because there are no inline, copy-paste-ready commands for common cases such as running the Spectral linter or invoking scripts/generate-contract.sh.

4 / 5

Workflow Clarity

The 8 numbered steps form a clear scan-to-artifacts sequence with provider verification (step 7) and an error-handling table providing recovery guidance, matching anchor 4's 'most checkpoints present; minor validation gaps'. It is not 5 because validation is delegated to a separate error table rather than embedded as explicit validate-and-retry checkpoints in the workflow (e.g., a 'lint the spec with Spectral' step despite Spectral being a listed prerequisite), and not 3 because the sequence and most checkpoints are present.

4 / 5

Progressive Disclosure

The SKILL.md is a clear, well-organized overview with one-level-deep references that all exist (references/implementation.md, references/errors.md, references/examples.md) and are clearly signaled with inline markdown links at natural points, plus a real scripts/generate-contract.sh. No nested references and no bulk content that belongs in a separate file, matching the anchor-5 example.

5 / 5

Total

17

/

20

Passed

Description

78%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.

A well-constructed description that clearly and explicitly states both what the skill does and when to use it, with natural trigger phrases in third-person voice. Its main weakness is limited action coverage in the 'what' statement and missing common synonyms such as 'swagger' or 'API docs' in the triggers.

Suggestions

Expand the capability sentence to enumerate more of the skill's concrete actions, e.g., 'Generate API contracts, OpenAPI 3.0/3.1 specifications, and consumer-driven Pact contract tests from code, design documents, or schemas.'

Add common trigger synonyms users naturally say, such as 'swagger', 'API documentation', or 'API spec', to the trigger phrase list.

Mention linting/validation with Spectral as a capability in the description so the verification workflow is discoverable at trigger time.

DimensionReasoningScore

Specificity

Names the domain and exactly two concrete actions ('Generate API contracts and OpenAPI specifications') from two source types (code, design documents), which matches the anchor for 1-2 concrete actions without comprehensive coverage. It does not list several actions like the contract-testing or validation capabilities the skill actually covers, so it is not a 4.

3 / 5

Completeness

It explicitly answers what ('Generate API contracts and OpenAPI specifications from code or design documents') and when ('Use when documenting API contracts and specifications') plus concrete trigger phrases, matching the anchor-5 example structure. It cannot exceed 5 and clearly beats anchor 4 because the 'when' is explicit rather than merely present.

5 / 5

Trigger Term Quality

Explicit natural trigger phrases ('generate API contract', 'create OpenAPI spec', 'document API contract') provide good keyword coverage that most users would naturally say. It is not a 5 because common synonyms and variations such as 'swagger', 'API docs', or 'endpoint documentation' are missing.

4 / 5

Distinctiveness Conflict Risk

The OpenAPI/contract-testing niche with distinct triggers keeps conflict risk low, but there is minor overlap risk with closely related API-documentation or swagger skills, matching anchor 4. It is more specific than anchor 3's 'could still overlap with similar skills' and lacks the airtight niche of anchor 5.

4 / 5

Total

16

/

20

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.

Validation — 14 / 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/tons-of-skills-marketplace

Path

plugins/api-development/api-contract-generator/skills/generating-api-contracts/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.