components-guide

Guide developers in creating and integrating Convex components in convex.config.ts.

3|Updated Feb 13, 2026
One-click install
npx skills add https://github.com/tradewinds-center/rabbithole --skill components-guide-tradewinds-center
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: components-guide
Source: https://github.com/tradewinds-center/rabbithole/tree/main/.claude/plugins/convex/skills/components-guide
Command: npx skills add https://github.com/tradewinds-center/rabbithole --skill components-guide-tradewinds-center

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Convex components help engineering teams structure scalable backends by encapsulating features into isolated, reusable units.

Core Features & Use Cases

  • Component boundaries: define clear API surfaces and isolated data for each component.
  • Composable architectures: organize features as sibling components and orchestrate them from a main app.
  • Migration patterns: extract monolithic logic into components for better maintainability and reuse.

Quick Start

Create a new component, configure it in convex.config.ts, and start using it from your main app.

Frequently Asked Questions about components-guide

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I encapsulate backend features into reusable units for scalable architectures?

Building scalable backends with isolated features involves organizing logic into composable units. You define clear component boundaries for API surfaces and isolated data, then orchestrate these sibling components from a main app.

How do I configure and integrate Convex components in my application?

To integrate Convex components, you configure them within the convex.config.ts file. This allows your main application to orchestrate the encapsulated features and manage their dependencies, references, and assets effectively.

What is the best way to extract monolithic backend logic into modular components?

Extracting monolithic backend logic into modular components uses migration patterns to improve maintainability and reuse. You create isolated units with clear boundaries, configure them in convex.config.ts, and orchestrate them as siblings from a main app.

Do I need specific metadata files to create a Convex component?

Creating a Convex component requires a SKILL.md file with YAML frontmatter containing name and description. You can also include optional scripts, references, and assets directories to supply dependencies, references, and assets for the component.

When should I use isolated components for backend scalability instead of a monolithic structure?

You should use isolated components for backend scalability when you need to encapsulate features into reusable units. This approach enforces clear API surfaces and isolated data, enabling composable architectures that are more maintainable than monolithic structures.

How does component isolation work when managing scalable microservice architectures?

Component isolation works by defining clear API surfaces and isolated data for each unit within a scalable backend. This encapsulation allows features to function as modular, composable units orchestrated from a main application without direct interference.