Install the skill above, then run this in your AI tool:
/convex-create-component <your description>
About
Create reusable Convex components with clear boundaries and a small app-facing
API.
Source
What gets added to your project
Preview every file this package writes on install before you run the command above.
Summary
convex-create-component
Skill instructions
Convex Create Component
Create reusable Convex components with clear boundaries and a small app-facing
API.
When to Use
Creating a new Convex component in an existing app
Extracting reusable backend logic into a component
Building a third-party integration that should own its own tables and
workflows
Packaging Convex functionality for reuse across multiple apps
When Not to Use
One-off business logic that belongs in the main app
Thin utilities that do not need Convex tables or functions
App-level orchestration that should stay in convex/
Cases where a normal TypeScript library is enough
Workflow
Ask the user what they are building and what the end goal is. If the repo
already makes the answer obvious, say so and confirm before proceeding.
Choose the shape using the decision tree below and read the matching
reference file.
Decide whether a component is justified. Prefer normal app code or a regular
library if the feature does not need isolated tables, backend functions, or
reusable persistent state.
Make a short plan for:
what tables the component owns
what public functions it exposes
what data must be passed in from the app (auth, env vars, parent IDs)
what stays in the app as wrappers or HTTP mounts
Create the component structure with convex.config.ts, schema.ts, and
function files.
Implement functions using the component's own ./_generated/server imports,
not the app's generated files.
Wire the component into the app with app.use(...). If the app does not
already have convex/convex.config.ts, create it.
Call the component from the app through components.<name> using
ctx.runQuery, ctx.runMutation, or ctx.runAction.
If React clients, HTTP callers, or public APIs need access, create wrapper
functions in the app instead of exposing component functions directly.
Run npx convex dev and fix codegen, type, or boundary issues before
finishing.
Choose the Shape
Ask the user, then pick one path:
Goal
Shape
Reference
Component for this app only
Local
references/local-components.md
Publish or share across apps
Packaged
references/packaged-components.md
User explicitly needs local + shared library code
Hybrid
references/hybrid-components.md
Not sure
Default to local
references/local-components.md
Read exactly one reference file before proceeding.
Default Approach
Unless the user explicitly wants an npm package, default to a local component:
Put it under convex/components/<componentName>/
Define it with defineComponent(...) in its own convex.config.ts
Install it from the app's convex/convex.config.ts with app.use(...)
Let npx convex dev generate the component's own _generated/ files
Component Skeleton
A minimal local component with a table and two functions, plus the app wiring.
Note the reference path shape: a function in
convex/components/notifications/lib.ts is called as
components.notifications.lib.send from the app.
Critical Rules
Keep authentication in the app, because ctx.auth is not available inside
components.
Keep environment access in the app, because component functions cannot read
process.env.
Pass parent app IDs across the boundary as strings, because Id types become
plain strings in the app-facing ComponentApi.
Do not use v.id("parentTable") for app-owned tables inside component args or
schema, because the component has no access to the app's table namespace.
Import query, mutation, and action from the component's own
./_generated/server, not the app's generated files.
Do not expose component functions directly to clients. Create app wrappers
when client access is needed, because components are internal and need
auth/env wiring the app provides.
If the component defines HTTP handlers, mount the routes in the app's
convex/http.ts, because components cannot register their own HTTP routes.
If the component needs pagination, use paginator from convex-helpers
instead of built-in .paginate(), because .paginate() does not work across
the component boundary.
Define indexes for queried fields instead of using Convex .filter() after a
database query.
Add args and returns validators to all public component functions, because
the component boundary requires explicit type contracts.
Patterns
Authentication and environment access
ts
// Bad: component code cannot rely on app auth or envconst identity = await ctx.auth.getUserIdentity();
const apiKey = process.env.OPENAI_API_KEY;
ts
// Good: the app resolves auth and env, then passes explicit valuesconst userId = awaitgetAuthUserId(ctx);
if (!userId) thrownewError("Not authenticated");
await ctx.runAction(components.translator.translate, {
userId,
apiKey: process.env.OPENAI_API_KEY,
text: args.text,
});
Client-facing API
ts
// Bad: assuming a component function is directly callable by clientsexportconst send = components.notifications.send;
// Bad: parent app table IDs are not valid component validatorsargs: {
userId: v.id("users"),
}
ts
// Good: treat parent-owned IDs as strings at the boundaryargs: {
userId: v.string(),
}
Advanced Patterns
For additional patterns including function handles for callbacks, deriving
validators from schema, static configuration with a globals table, and
class-based client wrappers, see references/advanced-patterns.md.
Add this badge to a GitHub README so readers can open the package page and install the same version.
[](https://www.aipm-registry.com/skills/convex/convex-create-component/1.0.0?utm_source=github&utm_medium=readme&utm_campaign=package_badge)
This imported publisher has not claimed its AIPM account. A connected account confirms account control, but it does not guarantee that a package is safe.
AI assistant context
What this skill is for
@convex/convex-create-component@1.0.0 is an AIPM skill package for All tools. Use it when a project needs the reusable AI behavior described as: convex-create-component
Explain an existing Convex app — data model + relationships, public vs internal functions, auth/ownership model, components, a request→data flow — read from the schema and function surface. Read-only.
Suggest the matching Convex component when the user hand-rolls a pattern it already solves (crons, sharded-counter, rate-limiter, storage, search, presence, workflow, RAG, prosemirror-sync). Passive — suggest after the task, never interr...
Run aipm add @convex/convex-create-component@1.0.0 in a project that has AIPM initialized.
Supported tools
@convex/convex-create-component@1.0.0 supports All tools.
Before installing
AIPM skills can add files to your project. Review the package name, target, description, license, and publisher before installing. Use a clean branch when trying a new skill.