You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Replace MCP server recommendations with LiveKit CLI
Rewrite AGENTS.md and README.md to lead with the LiveKit CLI (`lk docs`)
as the primary way to give coding agents LiveKit documentation access.
The MCP server is retained as a secondary option for deeper IDE
integration.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: AGENTS.md
+13-22Lines changed: 13 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,41 +14,32 @@ Be sure to maintain code formatting. You can use the ruff formatter/linter as ne
14
14
15
15
## LiveKit Documentation
16
16
17
-
LiveKit 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.io/mcp.
17
+
LiveKit 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 both a CLI and an MCP server that can be used to browse and search its documentation. If the developer has not yet installed the CLI, you should recommend that they install it.
18
18
19
-
### LiveKit Docs MCP Server installation
19
+
### LiveKit CLI
20
20
21
-
If you are Cursor, give the user this link to install the server:
21
+
The [LiveKit CLI](https://docs.livekit.io/intro/basics/cli/)`lk docs` subcommand gives full access to LiveKit documentation from the terminal. Requires CLI version 2.15.0+. Check with `lk --version`.
claude mcp add --transport http livekit-docs https://docs.livekit.io/mcp
29
-
```
29
+
Run `lk docs --help` to see all available commands. Key commands: `lk docs overview`, `lk docs search`, `lk docs get-page`, `lk docs code-search`, `lk docs changelog`, `lk docs submit-feedback`. Run `lk docs <command> --help` before using a command for the first time, as the help text includes advice on usage and interpreting results. Prefer browsing (`overview`, `get-page`) over search, and prefer `search` over `code-search`, as docs pages are more up-to-date and provide better context than raw code.
30
30
31
-
If you are Codex, use this command to install the server:
For deeper IDE integration, LiveKit also offers an [MCP server](https://docs.livekit.io/reference/other/docs-mcp/) with the same documentation access. It uses Streamable HTTP transport at `https://docs.livekit.io/mcp`. Refer to your IDE's documentation for how to add it.
36
34
37
-
If you are Gemini, use this command to install the server:
If you are another agentic IDE, refer to your own documentation for how to install it.
37
+
If you use the LiveKit CLI or MCP Server to search or browse documentation, also submit constructive feedback to LiveKit with `lk docs submit-feedback` or the MCP `submit_docs_feedback` tool. Add this to your to-do list when planning work, to ensure you file feedback after completing your other tasks. Useful feedback includes incomplete documentation, broken examples, missing steps or any other documentation gap or issue.
43
38
44
39
## Handoffs and tasks ("workflows")
45
40
46
41
Voice AI agents are highly sensitive to excessive latency. For this reason, it's important to design complex agents in a structured manner that minimizes the amount of irrelevant context and unnecessary tools included in requests to the LLM. LiveKit Agents supports handoffs (one agent hands control to another) and tasks (tightly-scoped prompts to achieve a specific outcome) to support building reliable workflows. You should make use of these features, instead of writing long instruction prompts that cover multiple phases of a conversation. Refer to the [documentation](https://docs.livekit.io/agents/build/workflows/) for more information.
47
42
48
-
### Submit docs feedback to LiveKit
49
-
50
-
If you use the LiveKit Docs MCP Server to search or browse documentation, also submit constructive feedback to LiveKit with the submit_docs_feedback tool. Add this to your to-do list when planning work, to ensure you file feedback after completing your other tasks. Useful feedback includes incomplete documentation, broken examples, missing steps or any other documentation gap or issue.
51
-
52
43
## Testing
53
44
54
45
When possible, add tests for agent behavior. Read the [documentation](https://docs.livekit.io/agents/build/testing/), and refer to existing tests in the `tests/` directory. Run tests with `uv run pytest`.
@@ -57,6 +48,6 @@ Important: When modifying core agent behavior such as instructions, tool descrip
57
48
58
49
## LiveKit CLI
59
50
60
-
You can make use of the LiveKit CLI (`lk`) for various tasks, with user approval. Installation instructions are available at https://docs.livekit.io/home/cli if needed.
51
+
You can make use of the LiveKit CLI (`lk`) for various tasks, with user approval. Installation instructions are available at https://docs.livekit.io/intro/basics/cli/start/ if needed.
61
52
62
53
In particular, you can use it to manage SIP trunks for telephony-based agents. Refer to `lk sip --help` for more information.
Copy file name to clipboardExpand all lines: README.md
+24-17Lines changed: 24 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,33 +19,40 @@ The starter project includes:
19
19
20
20
This starter app is compatible with any [custom web/mobile frontend](https://docs.livekit.io/agents/start/frontend/) or [SIP-based telephony](https://docs.livekit.io/agents/start/telephony/).
21
21
22
-
## Coding agents and MCP
22
+
## Using coding agents
23
23
24
-
This project is designed to work with coding agents like [Cursor](https://www.cursor.com/) and [Claude Code](https://www.anthropic.com/claude-code).
24
+
This project is designed to work with coding agents like [Claude Code](https://claude.com/product/claude-code), [Cursor](https://www.cursor.com/), and [Codex](https://openai.com/codex/).
25
25
26
-
To get the most out of these tools, install the [LiveKit Docs MCP server](https://docs.livekit.io/mcp).
26
+
For your convenience, LiveKit offers both a CLI and an [MCP server](https://docs.livekit.io/reference/other/docs-mcp/) that can be used to browse and search its documentation. The [LiveKit CLI](https://docs.livekit.io/intro/basics/cli/) (`lk docs`) works with any coding agent that can run shell commands. Install it for your platform:
The `lk docs` subcommand requires version 2.15.0 or higher. Check your version with `lk --version` and update if needed. Once installed, your coding agent can search and browse LiveKit documentation directly from the terminal:
The project includes a complete [AGENTS.md](AGENTS.md) file for these assistants. You can modify this file your needs. To learn more about this file, see [https://agents.md](https://agents.md).
53
+
See the [Using coding agents](https://docs.livekit.io/intro/coding-agents/) guide for more details, including MCP server setup.
54
+
55
+
The project includes a complete [AGENTS.md](AGENTS.md) file for these assistants. You can modify this file to suit your needs. To learn more about this file, see [https://agents.md](https://agents.md).
49
56
50
57
## Dev Setup
51
58
@@ -62,7 +69,7 @@ Sign up for [LiveKit Cloud](https://cloud.livekit.io/) then set up the environme
62
69
-`LIVEKIT_API_KEY`
63
70
-`LIVEKIT_API_SECRET`
64
71
65
-
You can load the LiveKit environment automatically using the [LiveKit CLI](https://docs.livekit.io/home/cli/cli-setup):
72
+
You can load the LiveKit environment automatically using the [LiveKit CLI](https://docs.livekit.io/intro/basics/cli/start/):
66
73
67
74
```bash
68
75
lk cloud auth
@@ -107,7 +114,7 @@ Get started quickly with our pre-built frontend starter apps, or add telephony s
107
114
|**React Native**|[`livekit-examples/voice-assistant-react-native`](https://github.com/livekit-examples/voice-assistant-react-native)| Native mobile app with React Native & Expo |
108
115
|**Android**|[`livekit-examples/agent-starter-android`](https://github.com/livekit-examples/agent-starter-android)| Native Android app with Kotlin & Jetpack Compose |
109
116
|**Web Embed**|[`livekit-examples/agent-starter-embed`](https://github.com/livekit-examples/agent-starter-embed)| Voice AI widget for any website |
110
-
|**Telephony**|[📚 Documentation](https://docs.livekit.io/agents/start/telephony/)| Add inbound or outbound calling to your agent |
117
+
|**Telephony**|[Documentation](https://docs.livekit.io/agents/start/telephony/)| Add inbound or outbound calling to your agent |
111
118
112
119
For advanced customization, see the [complete frontend guide](https://docs.livekit.io/agents/start/frontend/).
0 commit comments