关于 copilotkit
CopilotKit 是面向使用 CopilotKit 和 AG-UI 的编码 Agent 的技能,指导其查阅最新文档与源代码,并介绍可选 MCP 服务的搜索方式,以及调试前的 CLI 检查步骤。
主要功能
- 01以 Markdown 获取文档
- 02通过文档索引查找页面
- 03用 MCP 工具搜索文档与源代码
- 04调试前检查项目连线
- 05区分当前 v2 与已弃用的 v1
适用场景
- 01编码前查询最新 CopilotKit API
- 02查找 AG-UI 协议文档或实现细节
- 03排查运行时和前端连线问题
MCP 相关
CopilotKit Claude Code 插件可加载 `copilotkit-docs` MCP 服务,提供 CopilotKit 文档与源代码、AG-UI 文档与 SDK 源代码的搜索工具。技能还列出了该服务的 Streamable HTTP 和 SSE 端点。
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ copilotkit/ copilotkit --skill copilotkit安装后在 Claude Code 中输入/copilotkit确认已加载。
详细介绍
CopilotKit
CopilotKit 的 API 在不断变化。写在技能文件里的任何内容从写下的那一刻起就开始过时,因此本技能有意几乎不包含 API 细节。它只告诉你当前答案在哪里,以及如何获取它。
在编写代码之前先查阅文档。 不是因为文档更方便,而是因为文档是从源码重新生成的,而记忆不是。
阅读文档
有两种方式阅读最新文档。先确认本次会话可以使用哪一种。
不使用 MCP 服务:抓取 Markdown 页面
这条路径始终可用。它只需要一种抓取 URL 的方式。
- 以 Markdown 获取任意文档页面。 在页面路径后加上
.md:https://docs.copilotkit.ai/<path>.md。例如https://docs.copilotkit.ai/quickstart.md和https://docs.copilotkit.ai/backend/copilot-runtime.md。响应类型为text/markdown。不存在的路径会返回 404,响应体为Not found。 - 查找路径。 从
https://docs.copilotkit.ai/llms.txt开始。它是一个简短、 精选的索引,包含指向主要页面的链接。对于其中未列出的页面,请阅读https://docs.copilotkit.ai/sitemap.xml,它列出了所有页面 URL。这两个索引列出的都是 HTML 页面 URL。抓取前先在 URL 后加上.md。站点根路径没有.md形式。 不要一次性抓取llms-full.txt。它包含所有页面,有数 MB 之大。 - 本技能中的链接。 诸如 quickstart 这样的链接是文档路径。
请以
https://docs.copilotkit.ai/quickstart.md抓取它。 - 库源码。 阅读
node_modules/@copilotkit/中已安装的包,或https://github.com/CopilotKit/CopilotKit中packages/下的源码。 - AG-UI 协议。 该协议有自己的文档,位于
https://docs.copilotkit.ai。其索引 为https://docs.ag-ui.com/llms.txt,其页面同样支持.md。
使用 MCP 服务:搜索工具
CopilotKit Claude Code 插件还在其 .mcp.json 中声明了一个 MCP 服务 copilotkit-docs。当该服务被加载时,它会针对四个独立的语料库添加搜索工具。这是一种更快的搜索方式。它不是必需的。如果这些工具不在当前会话中,请使用上方的 Markdown 页面。
| 工具 | 语料库 | 用途 |
|---|---|---|
search-docs | docs.copilotkit.ai | 用法、配置、指南、快速开始、生成的 API 参考 |
search-code | CopilotKit 库源代码 | 某个功能的实现方式,以及确切的签名。仅限库包,不包括示例或展示 |
search-ag-ui-docs | AG-UI 协议文档 | 协议本身:事件类型、传输方式、SDK |
search-ag-ui-code | AG-UI 协议 SDK 源代码 | 协议实现细节 |
explore-docs / explore-code | 任一目录树 | 当你还不知道要搜索什么时,用于浏览结构 |
CopilotKit 相关的问题去前两个。AG-UI 协议相关的问题去后两个。它们属于不同的仓库,search-docs 不会找到它们。
这些是语义搜索。 使用不同词语的多个短查询胜过单个长查询。如果结果偏离目标,请改写查询。不要把它放宽。如果某个页面看起来正确,但不包含你需要的术语,请如实说明。不要根据标题进行推断。
如果用户希望在插件之外使用搜索工具,可以自行添加该服务。端点是 https://mcp.copilotkit.ai/mcp(可流式 HTTP)和 https://mcp.copilotkit.ai/sse(SSE)。保留路径,因为仅主机名会返回 404。Build with agents 中有每种编码工具的步骤。不要自行把添加该服务作为设置步骤。Markdown 页面提供相同的内容。
答案在哪里
值得了解,这样搜索或获取就有落脚之处。每个链接都是一个文档路径:
- 入门 — 快速开始,以及用于 命令行驱动方式的 CLI
- 前端 — 前端工具、human-in-the-loop、 预构建组件、样式、 附件、语音
- 运行时 — 运行时、 HTTP 端点、运行器、 工厂模式、服务适配器、 认证
- Agent 框架 — 每个框架一个快速开始,位于
https://docs.copilotkit.ai/<framework>/quickstart.md。框架 slug 在llms.txt中,例如langgraph-python、mastra和crewai-crews。 - Intelligence — 概览 及其下的页面
- 无法正常工作 — 常见问题、
错误参考,以及针对应用实际报告的错误码生成的
CopilotKitCoreErrorCode - 协议 — AG-UI,以及关于协议本身的 AG-UI 文档
开始调试之前
先运行 CLI 的连线检查。它可以通过一条命令检查多达 11 项,而且几乎总是比阅读项目更快。根据应用选择合适的形式:
- No Intelligence(构建运行时的位置没有任何代码构造
CopilotKitIntelligence,并且不存在.copilotkit/project.json):npx copilotkit@latest verify --expect-runtime oss --round-trip --agent <id> --json --via skill:copilotkit - 其他情况:
npx copilotkit@latest verify --json --via skill:copilotkit
--via skill:copilotkit 只会告知 CopilotKit 的遥测系统,此调用来自这个技能。
如果 CLI 报告 Unknown option '--via',说明 npx 运行了旧的缓存版本:不带该标志重新运行命令。
不要仅仅为了让 verify 通过而运行 login 或 project select。这些命令会设置托管版 Intelligence,无法修复开源应用。请参阅 copilotkit-cli 技能。
存在两个版本
当前版本是 v2。从 /v2 子路径导入:@copilotkit/react-core/v2、@copilotkit/runtime/v2。包根路径是已弃用的 v1 接口,仍可解析,因此混用两者在导入时不会报错,却会在之后出现运行时不匹配。请先检查项目导入的是哪个子路径,再相信有关项目的其他任何信息。v1 已弃用,但仍受支持;迁移指南介绍了如何迁移。