mcpField
C
copilotkit

copilotkit

github.com/outlinedriven开发1465 次安装17 周前更新
代码仓库

关于 copilotkit

面向开发者的 CopilotKit Agent 界面实现技能,涵盖运行时、前端状态与操作,以及人在环路流程。它强调先选定运行时拓扑,并明确共享状态契约和中断处理。

主要功能

  1. 01运行时与 provider 配置
  2. 02按职责选择 hooks 和操作
  3. 03设计共享状态 schema
  4. 04HITL 中断流程
  5. 05验证持久化与恢复

适用场景

  1. 01配置 CopilotKit runtime endpoint
  2. 02将 Agent 状态连接到 UI
  3. 03实现前端操作处理器
  4. 04中断后恢复交互流程

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/outlinedriven/odin-codex-plugin --skill copilotkit

安装后在 Claude Code 中输入/copilotkit确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

agents/
openai.yaml
references/
coagents-shared-state.md
hitl-and-troubleshooting.md
hooks-and-actions.md
runtime-and-provider.md

详细介绍

CopilotKit

使用此技能可实现基于 CopilotKit 的 Agent 体验,并正确配置 Provider、选择运行时、共享状态、前端操作和中断处理。

快速判断

  • 在设置 CopilotKit Provider、运行时端点、钩子、共享状态渲染和人在回路体验时使用此技能。
  • 如果主要问题是后端图行为,请切换到 $langgraph。
  • 如果主要问题是协议事件合规性,请切换到 $ag-ui。
  • 如果主要问题是核心模型/工具编排逻辑,请切换到 $langchain。

工作流

  1. 选择运行时拓扑。 在修改 UI 前,决定使用 LangGraph platform 端点还是远程后端运行时。
  2. 配置 Provider 边界。 先设置 <CopilotKit> Provider 和运行时端点。
  3. 按职责选择钩子。 使用 useCoAgent 耦合状态,使用 useCopilotAction 执行前端操作,并使用中断钩子处理 HITL 流程。
  4. 定义共享状态契约。 区分输入、输出和内部状态,并确保序列化保持稳定。
  5. 实现 HITL 流程。 将中断载荷映射到明确的前端操作处理程序。
  6. 实现持久化行为。 选择线程/消息持久化策略,并确保恢复时状态一致。
  7. 验证端到端体验。 测试流式传输、工具可见性、共享状态渲染和恢复流程。

默认模式

  • 将运行时与 UI 关注点分离。
  • 明确并精简共享状态架构。
  • 确保操作处理程序具备幂等性。
  • 将中断视为类型化控制流,而非自由形式的消息。

故障模式

  • 端点不匹配(运行时 URL/类型错误)。
  • 钩子绑定到了错误的 Agent 名称或 Provider 作用域。
  • 由于架构不匹配,共享状态更新未能反映出来。
  • 中断操作处理程序未绑定到预期的载荷类型。

参考索引

仅加载当前子任务所需的内容。

  • 运行时和 Provider 设置:references/runtime-and-provider.md
  • 钩子和操作:references/hooks-and-actions.md
  • CoAgent 和共享状态:references/coagents-shared-state.md
  • HITL 和故障排查:references/hitl-and-troubleshooting.md

评论

支持 Markdown