CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

v2-api-conventions

The response, error, pagination, and validation contract every `/api/v2` endpoint must satisfy. Use when adding or changing a route under `apps/sim/app/api/v2/`, or when auditing one for conformance.

Quality

84%

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

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

An unusually high-signal conventions document: every rule names concrete files, helpers, and failure modes, and the contract-first workflow plus closing checklist give it genuine validation checkpoints. Its weakness is shape, not substance — at ~240 lines with no reference files, it front-loads everything (including RFC rationale and security analysis) into SKILL.md and repeats several points, where a leaner core with split-out references would serve progressive disclosure and token economy better.

Suggestions

Split the 'Deliberate non-adoptions' table, the 'Idempotency' section, and 'Cursors are opaque, not trusted' into reference files (e.g. references/non-adoptions.md, references/idempotency.md, references/cursor-security.md), leaving one-line verdicts with pointers in SKILL.md.

Deduplicate the cross-tenant 404-concealment explanation (Rule 2 vs. the checklist item) and the typed SQL bound-parameter rule (Rule 2's two long paragraphs) — state each once and reference it from the checklist.

Trim quoted RFC passages to the operative clause plus citation (e.g. keep '9457 §4 ... not to replace existing domain-specific formats' and drop the surrounding sentences) to cut the longest paragraphs to a few lines.

DimensionReasoningScore

Conciseness

The body is dense with genuinely non-obvious project knowledge and explains nothing Claude already knows, but it is still ~240 lines with padded passages: verbatim RFC quotes in the non-adoptions table, 150+ word discursive paragraphs (e.g., the 403-vs-404 authorization discussion), and points repeated across sections (404 concealment and the typed SQL bound-parameter rule each appear twice). Mostly efficient, but noticeably tighten-able — not the 4 anchor's 'minor instances'.

3 / 5

Actionability

Guidance is fully concrete and executable: exact file paths for every mechanism, named helpers (`v2PaginationFields`, `booleanQueryFlagSchema`, `ForbiddenOperationError`), a copy-paste code snippet, model validation messages, and runnable verification commands (`bun run type-check`, `bun run check:audits`). Specific examples cover the common cases of adding or auditing a route.

5 / 5

Workflow Clarity

Rule 5 lays out a clear ordered sequence (contract → use case → route → OpenAPI) where each layer is checked against the previous one, and the closing checklist is an explicit validation gate with commands and test files that fail until conformance is declared (list-pagination.test.ts, query-declaration.test.ts). The 'execute it somewhere before believing the suite' guidance adds an error-recovery checkpoint.

5 / 5

Progressive Disclosure

Section headers, the 'Where the machinery lives' table, and one README link give real structure, but there are no bundle files at all: large self-contained sections (the RFC-by-RFC 'Deliberate non-adoptions' table, idempotency semantics, cursor security analysis) are inlined in SKILL.md where the rubric expects them split into one-level-deep reference files. This is the 'some structure, content that should be separate is inline' anchor — better organized than anchor 2's header-less wall, but clearly short of the well-signaled references at 4.

3 / 5

Total

16

/

20

Passed

Description

87%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: it states a precise, third-person scope and pairs it with an explicit, path-anchored 'Use when' clause covering both authoring and auditing triggers. The only slack is minor keyword synonym coverage, which barely matters given how tightly scoped the niche is.

DimensionReasoningScore

Specificity

Names four concrete concerns — "response, error, pagination, and validation contract" — in third person, giving specific scope rather than generic actions. It stops short of the comprehensive multi-action enumeration of the 5 anchor, but exceeds the 1-2 actions of the 3 anchor.

4 / 5

Completeness

Explicitly answers what ("The response, error, pagination, and validation contract every `/api/v2` endpoint must satisfy") and when ("Use when adding or changing a route under `apps/sim/app/api/v2/`, or when auditing one for conformance") with concrete trigger phrases, matching the top anchor exactly.

5 / 5

Trigger Term Quality

Natural trigger phrases like "adding or changing a route", "auditing one for conformance", and the concrete path "apps/sim/app/api/v2/" cover the likely user phrasings well. A few natural synonyms (e.g., "endpoint", "handler", "API conventions") are missing, keeping it below the comprehensive 5 anchor.

4 / 5

Distinctiveness Conflict Risk

The trigger is pinned to a specific API surface (`/api/v2` routes in one app directory), giving it a clear niche with essentially no overlap risk against other skills.

5 / 5

Total

18

/

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

frontmatter_unknown_keys

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

Warning

relative_links

Relative link issues: 1 suspicious

Warning

Total

14

/

16

Passed

Repository

simstudioai/sim

Path

.agents/skills/v2-api-conventions/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.