CtrlK
BlogDocsLog inGet started
Tessl Logo

openapi-expert

OpenAPI/Swagger expert for API specification design, validation, and code generation

44

Quality

43%

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

Fix and improve this skill with Tessl

tessl review fix ./crates/openfang-skills/bundled/openapi-expert/SKILL.md
SKILL.md
Quality
Evals
Security

Quality

Content

55%

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

The body is a well-organized, mostly lean reference of OpenAPI design guidance with good structure and no bundle dependencies, but it stays at the advisory level: no runnable code, no sequenced workflow, and no validation checkpoint despite advocating CI linting. Adding concrete examples and an explicit validate/fix loop would raise actionability and workflow clarity.

Suggestions

Add at least one executable snippet or concrete command (e.g., a minimal Redocly/Spectral lint command or a sample components/schemas block) so guidance is copy-paste ready rather than purely descriptive.

Include a short sequenced workflow with an explicit validation checkpoint (e.g., 'draft spec -> run `spectral lint api.yaml` -> fix breaking-change errors -> regenerate client'), turning the CI-linting recommendation into a feedback loop.

Trim bullets that restate concepts Claude already knows (e.g., the path-vs-query-parameter explanation and enum-transition prose) to tighten token efficiency.

DimensionReasoningScore

Conciseness

The body is mostly efficient and free of true filler, but several bullets explain concepts Claude already knows (e.g., 'path parameters identify resources, query parameters filter or paginate', enum transitions) and the prose paragraphs could be tightened; it earns its place but is not maximally lean.

2 / 3

Actionability

It gives concrete, specific guidance (e.g., 'limit/offset or cursor-based patterns', 'openapi-generator with language-specific templates', 'discriminator with oneOf') but provides no executable code, commands, or copy-paste examples; the guidance is instructional rather than runnable.

2 / 3

Workflow Clarity

Sections are organized as discrete techniques/patterns/pitfalls, but there is no sequenced end-to-end workflow and, critically, no validation checkpoint despite explicitly recommending CI linting and breaking-change detection for a fragile operation — a missing feedback loop that caps the score at 2.

2 / 3

Progressive Disclosure

No bundle files are provided and the skill is under 50 lines; content is well-organized into clearly labeled sections (Key Principles, Techniques, Common Patterns, Pitfalls), satisfying the simple-skill allowance for a top score without external references.

3 / 3

Total

9

/

12

Passed

Description

32%

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 clearly identifies the OpenAPI/Swagger domain and names a few action categories, but it lacks any explicit 'Use when' trigger guidance and does not enumerate the multiple specific concrete actions that would make it a model description. Adding natural-language triggers and more granular capabilities would lift specificity and completeness.

Suggestions

Append an explicit 'Use when...' clause naming natural triggers, e.g. 'Use when designing, validating, or generating code from OpenAPI/Swagger specs, or when the user mentions REST API contracts, endpoints, or API documentation.'

List more concrete actions (e.g., compose schemas with allOf/oneOf/anyOf, define security schemes, generate client SDKs with openapi-generator, lint specs in CI) to move from broad categories to specific capabilities.

Add common natural phrasings users say ('REST API', 'API docs', 'endpoints', 'spec file') to improve trigger-term coverage.

DimensionReasoningScore

Specificity

Names the domain ('OpenAPI/Swagger') and a few concrete actions ('API specification design, validation, and code generation'), but the actions are broad categories rather than the multiple specific concrete operations (e.g., composing schemas, defining security schemes, generating stubs) that would warrant a 3.

2 / 3

Completeness

It states what the skill does but contains no 'Use when...' clause or equivalent explicit trigger guidance, which the guidelines say should cap completeness at 2; combined with only an implied 'when', it falls to the missing-trigger end.

1 / 3

Trigger Term Quality

It includes recognizable natural terms ('OpenAPI', 'Swagger', 'API specification', 'code generation'), but misses common phrasings a user would naturally say like 'REST API', 'API docs', 'endpoints', or 'spec file'; coverage is partial.

2 / 3

Distinctiveness Conflict Risk

The OpenAPI/Swagger niche is fairly clear and unlikely to conflict with unrelated skills, but the absence of explicit trigger context means it could still overlap with general API or code-generation skills.

2 / 3

Total

7

/

12

Passed

Validation

100%

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

Validation16 / 16 Passed

Validation for skill structure

No warnings or errors.

Repository
RightNow-AI/openfang
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.