CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

convex-component-authoring

Creates reusable Convex components with defineComponent, a clean client wrapper, their own schema, and an npm publish setup. Use when extracting a feature into a package, building something for the Convex component directory, or when a component's functions are not showing up in the parent app.

75

Quality

94%

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 tightly written, highly actionable authoring guide: complete executable code for a full component lifecycle, a coherent build sequence with validation checkpoints and a symptom-based recovery table, and clean one-level-deep reference splitting. The only weakness is mild redundancy where the boundary rules appear in three forms (rules list, mistakes table, checklist).

Suggestions

Consolidate the overlap between Boundary rules and Common mistakes: keep the mistakes table rows that add a symptom or failure mode (e.g. 'Always returns no user') and drop rows that merely restate a rule already listed.

The closing Checklist repeats boundary rules a third time; consider trimming it to verification-only items (dev runs clean, reference paths match, tested through the example app) to cut roughly 10 lines.

DimensionReasoningScore

Conciseness

The body is dense and domain-specific with no generic padding (it never explains what Convex or TypeScript is; every line is component-specific), but the boundary rules are stated three times — in the intro ("a component cannot read the parent's tables, ctx.auth, or process.env"), the Boundary rules section, and again across the Common mistakes table and Checklist. The repetition is functional (rules, symptom lookup, checklist) but the overlap between the mistakes table and boundary rules is a genuine trimming opportunity.

4 / 5

Actionability

Every stage ships complete, copy-paste-ready TypeScript: defineComponent, defineSchema with an index, fully validated mutation/query handlers, parent registration with app.use, a typed client wrapper class using Pick ctx types, and authenticated app-side wrappers. Concrete commands (npx convex dev, npx convex codegen), a folder layout, and edge cases (local-only components, a second named instance) are all covered.

5 / 5

Workflow Clarity

The sections follow the actual build order (component vs helper decision → folder layout → config → schema → functions → register → npx convex dev → client wrapper), with an explicit validation checkpoint after registration ("Run npx convex dev. It generates components.counter...") and a closing 10-item checklist including "npx convex dev runs clean" and "Tested through an example app". The Common mistakes table is a symptom → cause → fix feedback loop for error recovery, matching the top anchor.

5 / 5

Progressive Disclosure

The core authoring workflow lives inline while npm publishing detail (exports map, build order, versioning) is split into a real, substantive references/publishing.md that is clearly signaled with a conditional open-trigger: "open it when the component will be installed from a package rather than a local folder." References are one level deep; the assets/ folder holds only non-navigational logo files; section headers make navigation easy.

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: third-person voice, explicit what-and-when with multiple concrete triggers including a natural debugging symptom, and comprehensive capability naming. The only gap is a handful of missing synonyms for the publishing and reuse triggers.

Suggestions

Add one or two natural synonym triggers for the packaging path, e.g. "or when the user asks to publish or share a Convex component as an npm package".

Consider including a file-level trigger such as convex.config.ts or components.<name>, since users debugging registration often paste those identifiers.

DimensionReasoningScore

Specificity

"Creates reusable Convex components with defineComponent, a clean client wrapper, their own schema, and an npm publish setup" names four concrete deliverables that comprehensively cover what the body actually teaches (config, schema, functions, wrapper, publishing). It matches the top anchor (multiple specific concrete actions, comprehensive) rather than the 4 anchor, which requires minor coverage gaps.

5 / 5

Completeness

It explicitly answers what ("Creates reusable Convex components with defineComponent, a clean client wrapper, their own schema, and an npm publish setup") and when, via an explicit "Use when..." clause with three concrete trigger scenarios including a debugging symptom. This matches the top anchor exactly; the 4 anchor requires a less explicit 'when', which does not apply.

5 / 5

Trigger Term Quality

Natural user phrasings are present — "extracting a feature into a package", "building something for the Convex component directory", and especially the debugging symptom "a component's functions are not showing up in the parent app". A few natural synonyms are missing (e.g. "publish a Convex component to npm" as a user request, "reusable backend package", file-level triggers like convex.config.ts), so it sits at the good-coverage anchor rather than the comprehensive one.

4 / 5

Distinctiveness Conflict Risk

"Convex components", "defineComponent", and "the Convex component directory" carve out a clear niche with distinct triggers; only a generic npm-package-authoring skill could remotely overlap, and the Convex-specific vocabulary keeps it distinguishable. Minimal conflict risk.

5 / 5

Total

19

/

20

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.

Validation — 16 / 16 Passed

Validation for skill structure

No warnings or errors.

Repository

waynesutton/convexskills

Path

skills/convex-component-authoring/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.