copilotkit-runtime-patterns

name: copilotkit-runtime-patterns description: Server-side runtime patterns for CopilotKit. Use when setting up CopilotKit runtime endpoints (Express, Hono, Next.js), configuring agent runners, adding middleware, or securing the runtime. Triggers on backend tasks involving @copilotkitnext/runtime, agent registration, or API endpoint configuration. license: MIT metadata: author: copilotkit version: "1.0.0"

CopilotKit Runtime Patterns

Server-side runtime configuration patterns. Contains 15 rules across 5 categories.

When to Apply

Reference these guidelines when:

• Setting up CopilotKit runtime endpoints (Express, Hono, Next.js API routes)
• Choosing between InMemory and SQLite agent runners
• Adding middleware for logging, auth, or request modification
• Securing the runtime (CORS, auth, rate limiting)
• Optimizing runtime performance

Rule Categories by Priority

Quick Reference

1. Endpoint Setup (CRITICAL)

• endpoint-express-setup - Configure Express endpoint with correct path and CORS
• endpoint-hono-setup - Configure Hono endpoint for edge runtimes
• endpoint-nextjs-route - Set up Next.js API route handler correctly

2. Agent Runners (HIGH)

• runner-inmemory-vs-sqlite - Use InMemory for dev, SQLite for production persistence
• runner-agent-registration - Register agents with descriptive names and metadata
• runner-multiple-agents - Configure routing for multi-agent setups

3. Middleware (MEDIUM)

• middleware-before-request - Use beforeRequest for auth, logging, context injection
• middleware-after-request - Use afterRequest for response modification and cleanup
• middleware-error-handling - Handle errors in middleware without crashing the runtime

4. Security (HIGH)

• security-cors-config - Configure CORS for your specific frontend origin
• security-auth-middleware - Authenticate requests before agent execution
• security-rate-limiting - Rate limit by user or API key

5. Performance (MEDIUM)

• perf-streaming-response - Ensure streaming is not buffered by proxies
• perf-agent-timeout - Set agent execution timeouts
• perf-connection-pooling - Pool database connections for SQLite runner

Full Compiled Document

For the complete guide with all rules expanded: AGENTS.md