CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

common-api-design

Apply REST API conventions — HTTP semantics, status codes, versioning, pagination, and OpenAPI standards for any framework. Use when designing endpoints, choosing HTTP methods, implementing pagination, or writing OpenAPI specs.

73

Quality

92%

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

92%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 tight, highly actionable standards checklist with excellent progressive disclosure into a verified one-level reference file. The only deductions are minor: one line re-teaches universal HTTP status-code semantics, and the incoherent trailing 'Canonical response anchors' fragment should be removed or completed.

DimensionReasoningScore

Conciseness

The body is almost entirely lean rule bullets with no padding, but two things could be trimmed: the status-code line restates HTTP knowledge Claude already has ('200 success; 201 created… 404 not found'), and the trailing 'Canonical response anchors' section is a single-item fragment ('- DELETE') that adds noise. Not 5: these minor instances of over-explanation/filler keep it off the 'every token earns its place' anchor; not 3: the body is far tighter than 'mostly efficient with some unnecessary explanation'.

4 / 5

Actionability

Guidance is fully concrete and directly applicable: exact sub-resource pattern ('POST /orders/:id/cancel'), exact headers ('Location', 'Retry-After', 'Deprecation: true + Sunset: <date>'), exact defaults ('Default limit: 20, max 100'), an inline pagination envelope, and copy-paste-ready examples in references/REFERENCE.md. These cover the common cases an instruction-only skill needs.

5 / 5

Workflow Clarity

This is a single-purpose conventions skill with no multi-step or destructive workflow, so the simple-skill exception applies: applying the rules is unambiguous, and the sections progress logically (verbs → status codes → URLs → versioning → pagination → OpenAPI → security). No validation checkpoints are needed since no fragile operation sequence exists.

5 / 5

Progressive Disclosure

The body is a concise overview of rules, and bulk examples (URL table, error body, pagination envelope, deprecation headers) are appropriately split into a single well-signaled reference, [URL Examples, Status Codes & Pagination Envelope](references/REFERENCE.md), which exists in the bundle and is exactly one level deep. Not 4: navigation is clean with no organization gaps of consequence.

5 / 5

Total

19

/

20

Passed

Description

92%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 strong description: concrete domain enumeration, an explicit 'Use when…' clause with natural trigger phrases, and a clearly bounded niche. Only gap is a few missing synonyms (e.g., 'RESTful', 'swagger') in trigger coverage.

DimensionReasoningScore

Specificity

The description enumerates multiple concrete areas ('HTTP semantics, status codes, versioning, pagination, and OpenAPI standards') and concrete actions ('designing endpoints, choosing HTTP methods, implementing pagination, or writing OpenAPI specs'), giving comprehensive coverage of the REST design domain. Not 4: coverage spans essentially the whole domain rather than having minor gaps.

5 / 5

Completeness

It explicitly answers both what ('Apply REST API conventions — HTTP semantics, status codes, versioning, pagination, and OpenAPI standards for any framework') and when ('Use when designing endpoints, choosing HTTP methods, implementing pagination, or writing OpenAPI specs') with concrete trigger phrases, matching the top anchor exactly.

5 / 5

Trigger Term Quality

Natural phrases users would say are present ('designing endpoints', 'choosing HTTP methods', 'implementing pagination', 'writing OpenAPI specs'), but common variations like 'RESTful', 'swagger', or 'API documentation' are absent. Not 3: keyword coverage is broad and idiomatic, not partial; not 5: a few natural synonyms are missing.

4 / 5

Distinctiveness Conflict Risk

It occupies a clear niche (framework-agnostic REST API design conventions) with distinct triggers (endpoints, HTTP methods, pagination, OpenAPI specs), so wrong-skill triggering is unlikely. Not 4: the overlap with framework-specific routing skills is minimal given the explicit design-convention framing.

5 / 5

Total

19

/

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

metadata_version

'metadata.version' is missing

Warning

metadata_field

'metadata' should map string keys to string values

Warning

Total

14

/

16

Passed

Repository

HoangNguyen0403/agent-skills-standard

Path

.agents/skills/common/common-api-design/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.