CopilotKit v2 开发技能用于在应用中构建 AI 驱动功能,例如添加聊天界面、注册前端工具、向智能体共享应用上下文等。
一、实时文档(MCP) 该插件包含一个 MCP 服务器(copilotkit-docs),提供 search-docs 和 search-code 工具,用于查询实时的 CopilotKit 文档与源代码。在 Claude Code 中由插件的 .mcp.json 自动配置,无需额外设置;在 Codex 中需要手动配置,具体设置说明参见 copilotkit-debug 技能。
二、架构概览 CopilotKit v2 构建在 AG-UI 协议(@ag-ui/client / @ag-ui/core)之上,技术栈分为三层:
- 运行时(@copilotkit/runtime):服务端,承载智能体,处理 SSE/Intelligence 传输、中间件与转录。
- 核心(@copilotkit/core):共享状态管理、工具注册表、建议引擎,应用不直接导入。
- React(@copilotkit/react):Provider、聊天组件与 hooks,并重新导出 @ag-ui/client 的全部内容,因此应用只需一次导入。
三、工作流程
- 设置运行时(服务端):创建 CopilotRuntime(或显式的 CopilotSseRuntime / CopilotIntelligenceRuntime),并通过 createCopilotEndpoint(Hono)或 createCopilotEndpointExpress(Express)暴露。
- 用 Provider 包裹应用(客户端):使用 CopilotKitProvider,配置 runtimeUrl。
- 添加聊天 UI:使用 <CopilotChat>、<CopilotPopup> 或 <CopilotSidebar>。
- 注册前端工具:使用 useFrontendTool,让智能体调用浏览器中的函数。
- 共享应用上下文:使用 useAgentContext 向智能体提供运行时数据。
- 处理智能体中断:使用 useInterrupt,在智能体暂停等待人工输入时渲染界面并 resolve。
- 在聊天中渲染工具调用:使用 useRenderTool,按工具名或通配符 "*" 注册渲染器。
四、Hooks 快速参考
- useFrontendTool:注册智能体可在浏览器中调用的工具。
- useComponent:将 React 组件注册为聊天渲染工具(useFrontendTool 的便捷封装)。
- useAgentContext:与智能体共享可 JSON 序列化的应用状态。
- useAgent:按智能体 ID 获取 AbstractAgent 实例,订阅消息/状态/运行状态变化。
- useInterrupt:处理智能体的 on_interrupt 事件,支持 render 及可选 handler/filter。
- useHumanInTheLoop:注册一个工具,暂停执行直到用户通过渲染的 UI 响应。
- useRenderTool:按名称或通配符 "*" 注册工具调用的渲染器。
- useDefaultRenderTool:使用内置可展开卡片 UI 注册通配符 "*" 渲染器。
- useRenderToolCall:内部 hook,返回为给定工具调用解析正确渲染器的函数。
- useRenderActivityMessage:内部 hook,按类型渲染活动消息。
- useRenderCustomMessages:内部 hook,渲染自定义消息装饰器。
- useSuggestions:读取当前建议列表并控制重新加载/清除。
- useConfigureSuggestions:注册静态或动态(LLM 生成)的建议配置。
- useThreads:列出、重命名、归档和删除 Intelligence 平台线程。
五、组件快速参考
- CopilotKitProvider:根 Provider,配置运行时 URL、请求头、智能体、错误处理器。
- CopilotChat:连接到智能体的完整聊天界面(内联布局)。
- CopilotPopup:带切换按钮的浮动弹窗聊天。
- CopilotSidebar:带切换按钮的可折叠侧边栏聊天。
- CopilotChatView:无头聊天视图,为消息视图、输入、滚动、建议提供插槽。
- CopilotChatInput:带发送/停止/转录控制的聊天输入文本域。
- CopilotChatMessageView:渲染消息列表。
- CopilotChatSuggestionView:渲染建议胶囊。
六、运行时快速参考
- CopilotRuntime:自动检测的运行时(委托给 SSE 或 Intelligence)。
- CopilotSseRuntime:显式的 SSE 模式运行时。
- CopilotIntelligenceRuntime:带持久线程的 Intelligence 模式运行时。
- createCopilotEndpoint:创建包含所有 CopilotKit 路由的 Hono 应用。
- createCopilotEndpointExpress:创建包含所有 CopilotKit 路由的 Express 路由器。
- CopilotKitIntelligence:Intelligence 平台客户端配置。
七、适用场景与限制 适用于使用 CopilotKit v2 构建 AI 功能的前端与全栈开发场景,包括聊天界面、前端工具调用、上下文共享、人工介入与工具调用自定义渲染。资料未提供收费、价格、平台支持范围及具体效果等信息。