概述
LiveKit 包含一个免费的 模型上下文协议 (MCP) 服务器,其中包含用于 AI 编码助手浏览和搜索文档站点的工具。以下说明涵盖 MCP 服务器的安装以及编写 AGENTS.md 文件 的建议,以便充分利用您的编码助手。
服务器的 URL 如下
https://docs.livekit.net.cn/mcp
安装
以下部分涵盖了各种编码助手安装说明。
Cursor
单击下面的按钮在 Cursor 中安装 MCP 服务器
或者使用以下 JSON 手动添加
{"livekit-docs": {"url": "https://docs.livekit.net.cn/mcp"}}
Claude Code
在您的终端中运行以下命令,以在 Claude Code 中安装 MCP 服务器
claude mcp add --transport http livekit-docs https://docs.livekit.net.cn/mcp
Codex
在您的终端中运行以下命令以使用 OpenAI Codex 安装服务器
codex mcp add --url https://docs.livekit.net.cn/mcp livekit-docs
Gemini CLI
在您的终端中运行以下命令以使用 Gemini CLI 安装服务器
gemini mcp add --transport http livekit-docs https://docs.livekit.io/mcp
手动安装
MCP 服务器在以下 URL 可用。将此服务器添加到您选择的 MCP 客户端。如果提示,请将传输设置为 http 或“Streamable HTTP”。
https://docs.livekit.net.cn/mcp
AGENTS.md
为了充分利用 MCP 服务器,LiveKit 建议您在您的仓库中包含一个 AGENTS.md 或类似文件,其中包含针对 LiveKit Docs MCP 服务器的具体说明。此文件可确保您的代理始终查阅 LiveKit 文档,以生成可靠且可用的代码。
LiveKit 的许多入门仓库已经包含一个强大的 AGENTS.md 文件,该文件针对特定项目和环境进行了优化。
Python starter project
包含一个 AGENTS.md 文件,该文件针对使用 Python 构建代理进行了优化。
Node.js starter project
包含一个 AGENTS.md 文件,该文件针对使用 Node.js 构建代理进行了优化。
或者,您可以将以下说明添加到您自己的 AGENTS.md 文件
## LiveKit DocumentationLiveKit Agents is a fast-evolving project, and the documentation is updated frequently. You should always refer to the latest documentation when working with this project. For your convenience, LiveKit offers an MCP server that can be used to browse and search its documentation. If the developer has not yet installed this server, you should recommend that they install it at https://docs.livekit.net.cn/mcp.
Markdown 文档
LiveKit 文档网站上的每个页面都提供 Markdown 格式,针对在 MCP 不可用时粘贴到 AI 助手中进行了优化。
要访问网站上任何页面的 Markdown 版本,请在 URL 结尾附加 .md。例如,此页面在 https://docs.livekit.net.cn/intro/mcp-server.md 上可用。您还可以使用任何文档页面的右上角的“复制页面”按钮。
LLMs.txt
一个完整的基于 Markdown 的文档站点索引可在 https://docs.livekit.net.cn/llms.txt 处找到。该文件包含一个目录以及简短的页面描述。扩展版本可在 https://docs.livekit.net.cn/llms-full.txt 处找到,但此文件非常大,可能不适合所有用例。
有关如何使用 LLMs.txt 文件的更多信息,请参阅 llmstxt.org。