关于 reading-livekit-docs
指导开发者在编写 LiveKit 代码前查阅当前文档的技能,避免依赖过时记忆。它说明如何使用 LiveKit Docs MCP 服务、`lk docs` 和网页搜索,并提供核实与报告要求。
主要功能
- 01优先使用 LiveKit Docs MCP 服务
- 02通过 `lk docs` 搜索和获取文档
- 03按需查询代码示例与更新日志
- 04以已安装版本和帮助信息核对
- 05引用来源并标注未验证内容
适用场景
- 01查证 LiveKit API 的当前用法
- 02确认 CLI 标志和默认值
- 03调查 SDK 功能的版本变化
- 04在文档来源不一致时判断依据
MCP 相关
说明如何通过 LiveKit Docs MCP 服务查询文档;若会话中没有相应工具,则建议使用 `lk docs`,再考虑网页搜索。
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ livekit/ agent-skills --skill reading-livekit-docs安装后在 Claude Code 中输入/reading-livekit-docs确认已加载。
详细介绍
阅读 LiveKit 文档
LiveKit 的 SDK 更新速度比模型训练数据快,因此你对 LiveKit API、CLI 标志或默认值的任何记忆都只是猜测。错误的猜测会浪费时间:标志错了会白跑一遍,签名错了会白费一次构建。
你陈述或写入代码的每一条 LiveKit 专属信息,都应来自本次会话中的查证。 这包括你确信的事实,以及你在其他仓库中见过的模式。
查找资料的优先顺序
1. LiveKit Docs MCP 服务。 如果当前会话中提供了它的工具,就使用它们。它们与 CLI 使用的是同一信息源,而且操作更便捷。
2. lk docs。 只要安装了 LiveKit CLI,就可以使用,无需配置 MCP。如果没有 MCP 工具,就使用它;不要先停下来询问用户是否要安装任何东西。它可以搜索文档、获取页面、搜索 LiveKit 各个仓库中的代码、查看 SDK 最近的变更日志、查询定价以及提交反馈。请从以下内容开始:
lk docs --help
lk docs search "agent simulations"
搜索找到正确页面后,再获取该页面。如果你更愿意解析而不是阅读,也可以使用机器可读的输出。
3. 在 docs.livekit.io 上进行网页搜索。 仅当以上两种方式都不可用时使用。告诉用户你改用了这种方式,并将生成的代码标记为未经验证。
如何调研
- 先搜索,再阅读。 搜索结果会返回每个页面的摘录,通常足以选出正确的页面。确定需要哪个页面后再获取完整内容,否则未使用的页面会占满上下文窗口。
- 如何使用代码搜索,查找什么则看文档。 文档会说明某个参数是否存在。LiveKit 自己的示例会展示如何调用。如果文档页面与可运行示例不一致,就采用示例,并说明这一差异。
- 版本问题要查变更日志。 “X 现在可用了吗”“Y 是什么时候改的”和“为什么没有这个参数”等问题,应通过变更日志而不是搜索来解答。
- 检查当前使用的版本。 已安装的 SDK 和 CLI 决定了哪些内容可用;文档中记载的功能可能在已安装版本中不存在。对于任何 CLI 命令,已安装二进制文件的
--help输出优先于其他所有来源。
报告查找结果
- 在决策依据某个页面时引用该页面, 方便用户核实。
- 说明无法验证的内容。 “我无法根据文档确认此签名”对用户有帮助。默默猜测则没有帮助。
- 标记未经验证的代码。 如果你在没有查证的情况下编写了 LiveKit 代码,就在调用处添加注释,说明代码未经验证,并在回复中说明。
- 不要为了让示例看起来完整而编造标志或参数。 附带说明的不完整示例,也好过看似合理的杜撰内容。
文档有误时
有时页面内容会与 SDK 源码或 CLI 的 --help 输出相矛盾。遇到这种情况:
- 采用实际可运行的内容。
--help、已安装 SDK 的源码和可运行示例,优先于说明性页面。告诉用户你采用了哪种来源以及原因。 - 通过文档反馈命令报告问题, 并告知用户你已提交反馈,避免下一个人遇到相同错误。
当文档服务比 CLI 略新时,lk docs 有时会提示版本不一致。这很常见,查询结果仍然可靠。建议更新 lk,然后继续操作。
相关技能
- 构建 Agent:
building-livekit-agents - 在开发期间进行实时测试:
debugging-livekit-agents - 单元测试:
testing-livekit-agents - 模拟:
writing-livekit-scenarios、running-livekit-simulations