CopilotKit-agent-patterns — CopilotKit-代理-patterns

CopilotKit 代理 Patterns

Architecture and implementation patterns for building AI 代理s that connect to CopilotKit. ContAIns 20 rules across 5 categories, prioritized by impact.

When to 应用ly

Reference these 图形界面delines when:

De签名ing 代理 architecture for CopilotKit integration Implementing AG-UI protocol event 流ing Managing 状态 同步hronization between 代理 and frontend 添加ing human-in-the-loop 检查points to 代理 工作流s Emitting 工具 calls that render generative UI in the frontend Rule Categories by Priority Priority Category Impact Prefix 1 代理 Architecture CRITICAL architecture- 2 AG-UI Protocol HIGH a图形界面- 3 状态 Management HIGH 状态- 4 Human-in-the-Loop MEDIUM hitl- 5 Generative UI Emission MEDIUM genui- Quick Reference

• 代理 Architecture (CRITICAL)

architecture-built-in-代理 - Use BuiltIn代理 from @copilotkit/运行time/v2 for simple 代理s architecture-模型-resolution - Use 提供者/模型 string 格式化 for 模型 selection architecture-max-steps - 设置 maxSteps to 预防 infinite 工具 call loops architecture-mcp-servers - 配置 MCP 端点s for external 工具 访问

• AG-UI Protocol (HIGH)

a图形界面-event-ordering - Emit 事件 in correct order (启动 -> content -> end) a图形界面-text-流ing - 流 text incrementally, not as single blocks a图形界面-工具-call-lifecycle - Follow the complete 工具 call event lifecycle a图形界面-状态-snapshot - Emit 状态_SNAPSHOT 事件 for frontend 同步 a图形界面-error-事件 - Always emit error 事件 on 失败

• 状态 Management (HIGH)

状态-snapshot-frequency - Emit 状态 snapshots at meaningful 检查points 状态-minimal-payload - Keep 状态 snapshots minimal and serializable 状态-conflict-resolution - Handle bidirectional 状态 conflicts gracefully 状态-thread-isolation - Isolate 状态 per thread, not per 代理

• Human-in-the-Loop (MEDIUM)

hitl-应用roval-gates - Use 工具 calls for 应用roval gates, not custom 事件 hitl-timeout-fallback - Always 设置 timeouts with fallback behavior hitl-上下文-in-prompt - Include sufficient 上下文 for user decisions hitl-恢复-状态 - Preserve full 状态 when resuming after 应用roval

• Generative UI Emission (MEDIUM)

genui-工具-call-render - Emit 工具 calls that map to frontend useRender工具 genui-流ing-args - 流 工具 args incrementally for real-time UI genui-activity-messages - Use text messages for non-工具 状态 更新s How to Use

Read individual rule files for detAIled explanations and code examples:

rules/architecture-built-in-代理.md rules/a图形界面-event-ordering.md

Full Compiled Document

For the complete 图形界面de with all rules expanded: 代理S.md