Skip to content

Commit 2c53ee3

Browse files
bcherryclaude
andauthored
Replace MCP server recommendations with LiveKit CLI (#54)
* Use deepgram * Switch Deepgram STT to nova-3 multi * 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> * Consolidate bottom CLI section to match node starter Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Update docs URLs to match new site structure Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Port remaining URL and content updates from Node starter PR Updates docs URLs to match new site structure: - /agents/build/ -> /agents/logic/ and /agents/start/ - /home/cloud/ -> /transport/media/ - /home/self-hosting/ -> /transport/self-hosting/local/ - /agents/ops/deployment/ -> /deploy/agents/ - Metrics/logging -> Agent Observability - Voice pipeline description updated Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent a7d8709 commit 2c53ee3

File tree

2 files changed

+51
-55
lines changed

2 files changed

+51
-55
lines changed

AGENTS.md

Lines changed: 14 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -14,49 +14,38 @@ Be sure to maintain code formatting. You can use the ruff formatter/linter as ne
1414

1515
## LiveKit Documentation
1616

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.
1818

19-
### LiveKit Docs MCP Server installation
19+
### LiveKit CLI
2020

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`.
2222

23-
[![Install MCP Server](https://cursor.com/deeplink/mcp-install-light.svg)](https://cursor.com/en-US/install-mcp?name=livekit-docs&config=eyJ1cmwiOiJodHRwczovL2RvY3MubGl2ZWtpdC5pby9tY3AifQ%3D%3D)
23+
Install or update the CLI:
2424

25-
If you are Claude Code, run this command to install the server:
25+
- **macOS:** `brew install livekit-cli` (update: `brew update && brew upgrade livekit-cli`)
26+
- **Linux:** `curl -sSL https://get.livekit.io/cli | bash`
27+
- **Windows:** `winget install LiveKit.LiveKitCLI` (update: `winget upgrade LiveKit.LiveKitCLI`)
2628

27-
```
28-
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.
3030

31-
If you are Codex, use this command to install the server:
31+
### LiveKit Docs MCP Server
3232

33-
```
34-
codex mcp add --url https://docs.livekit.io/mcp livekit-docs
35-
```
33+
For deeper IDE integration, LiveKit also offers an [MCP server](https://docs.livekit.io/reference/developer-tools/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.
3634

37-
If you are Gemini, use this command to install the server:
38-
```
39-
gemini mcp add --transport http livekit-docs https://docs.livekit.io/mcp
40-
```
35+
### Submit docs feedback to LiveKit
4136

42-
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.
4338

4439
## Handoffs and tasks ("workflows")
4540

4641
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.
4742

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-
5243
## Testing
5344

54-
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`.
45+
When possible, add tests for agent behavior. Read the [documentation](https://docs.livekit.io/agents/start/testing/), and refer to existing tests in the `tests/` directory. Run tests with `uv run pytest`.
5546

5647
Important: When modifying core agent behavior such as instructions, tool descriptions, and tasks/workflows/handoffs, never just guess what will work. Always use test-driven development (TDD) and begin by writing tests for the desired behavior. For instance, if you're planning to add a new tool, write one or more tests for the tool's behavior, then iterate on the tool until the tests pass correctly. This will ensure you are able to produce a working, reliable agent for the user.
5748

5849
## LiveKit CLI
5950

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.
61-
62-
In particular, you can use it to manage SIP trunks for telephony-based agents. Refer to `lk sip --help` for more information.
51+
Beyond documentation access, the LiveKit CLI (`lk`) supports other tasks such as managing SIP trunks for telephony-based agents. Run `lk --help` to explore available commands.

README.md

Lines changed: 37 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -9,43 +9,50 @@ A complete starter project for building voice AI apps with [LiveKit Agents for P
99
The starter project includes:
1010

1111
- A simple voice AI assistant, ready for extension and customization
12-
- A voice AI pipeline with [models](https://docs.livekit.io/agents/models) from OpenAI, Cartesia, and Deepgram served through LiveKit Cloud
13-
- Easily integrate your preferred [LLM](https://docs.livekit.io/agents/models/llm/), [STT](https://docs.livekit.io/agents/models/stt/), and [TTS](https://docs.livekit.io/agents/models/tts/) instead, or swap to a realtime model like the [OpenAI Realtime API](https://docs.livekit.io/agents/models/realtime/openai)
14-
- Eval suite based on the LiveKit Agents [testing & evaluation framework](https://docs.livekit.io/agents/build/testing/)
15-
- [LiveKit Turn Detector](https://docs.livekit.io/agents/build/turns/turn-detector/) for contextually-aware speaker detection, with multilingual support
16-
- [Background voice cancellation](https://docs.livekit.io/home/cloud/noise-cancellation/)
17-
- Integrated [metrics and logging](https://docs.livekit.io/agents/build/metrics/)
18-
- A Dockerfile ready for [production deployment](https://docs.livekit.io/agents/ops/deployment/)
12+
- A voice AI pipeline built on [LiveKit Inference](https://docs.livekit.io/agents/models/inference)
13+
with [models](https://docs.livekit.io/agents/models) from OpenAI, Cartesia, and Deepgram. More than 50 other model providers are supported, including [Realtime models](https://docs.livekit.io/agents/models/realtime)
14+
- Eval suite based on the LiveKit Agents [testing & evaluation framework](https://docs.livekit.io/agents/start/testing/)
15+
- [LiveKit Turn Detector](https://docs.livekit.io/agents/logic/turns/turn-detector/) for contextually-aware speaker detection, with multilingual support
16+
- [Background voice cancellation](https://docs.livekit.io/transport/media/noise-cancellation/)
17+
- Deep session insights from LiveKit [Agent Observability](https://docs.livekit.io/deploy/observability/)
18+
- A Dockerfile ready for [production deployment to LiveKit Cloud](https://docs.livekit.io/deploy/agents/)
1919

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/).
20+
This starter app is compatible with any [custom web/mobile frontend](https://docs.livekit.io/frontends/) or [telephony](https://docs.livekit.io/telephony/).
2121

22-
## Coding agents and MCP
22+
## Using coding agents
2323

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/).
2525

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/developer-tools/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:
2727

28-
For Cursor, use this link:
28+
**macOS:**
2929

30-
[![Install MCP Server](https://cursor.com/deeplink/mcp-install-light.svg)](https://cursor.com/en-US/install-mcp?name=livekit-docs&config=eyJ1cmwiOiJodHRwczovL2RvY3MubGl2ZWtpdC5pby9tY3AifQ%3D%3D)
30+
```console
31+
brew install livekit-cli
32+
```
3133

32-
For Claude Code, run this command:
34+
**Linux:**
3335

34-
```
35-
claude mcp add --transport http livekit-docs https://docs.livekit.io/mcp
36+
```console
37+
curl -sSL https://get.livekit.io/cli | bash
3638
```
3739

38-
For Codex CLI, use this command to install the server:
39-
```
40-
codex mcp add --url https://docs.livekit.io/mcp livekit-docs
41-
```
40+
**Windows:**
4241

43-
For Gemini CLI, use this command to install the server:
42+
```console
43+
winget install LiveKit.LiveKitCLI
4444
```
45-
gemini mcp add --transport http livekit-docs https://docs.livekit.io/mcp
45+
46+
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:
47+
48+
```console
49+
lk docs search "voice agents"
50+
lk docs get-page /agents/start/voice-ai-quickstart
4651
```
4752

48-
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).
4956

5057
## Dev Setup
5158

@@ -74,7 +81,7 @@ Sign up for [LiveKit Cloud](https://cloud.livekit.io/) then set up the environme
7481
- `LIVEKIT_API_KEY`
7582
- `LIVEKIT_API_SECRET`
7683

77-
You can load the LiveKit environment automatically using the [LiveKit CLI](https://docs.livekit.io/home/cli/cli-setup):
84+
You can load the LiveKit environment automatically using the [LiveKit CLI](https://docs.livekit.io/intro/basics/cli/):
7885

7986
```bash
8087
lk cloud auth
@@ -85,7 +92,7 @@ lk app env -w -d .env.local
8592

8693
## Run the agent
8794

88-
Before your first run, you must download certain models such as [Silero VAD](https://docs.livekit.io/agents/build/turns/vad/) and the [LiveKit turn detector](https://docs.livekit.io/agents/build/turns/turn-detector/):
95+
Before your first run, you must download certain models such as [Silero VAD](https://docs.livekit.io/agents/logic/turns/vad/) and the [LiveKit turn detector](https://docs.livekit.io/agents/logic/turns/turn-detector/):
8996

9097
```console
9198
uv run python src/agent.py download-files
@@ -121,13 +128,13 @@ Get started quickly with our pre-built frontend starter apps, or add telephony s
121128
| **React Native** | [`livekit-examples/voice-assistant-react-native`](https://github.com/livekit-examples/voice-assistant-react-native) | Native mobile app with React Native & Expo |
122129
| **Android** | [`livekit-examples/agent-starter-android`](https://github.com/livekit-examples/agent-starter-android) | Native Android app with Kotlin & Jetpack Compose |
123130
| **Web Embed** | [`livekit-examples/agent-starter-embed`](https://github.com/livekit-examples/agent-starter-embed) | Voice AI widget for any website |
124-
| **Telephony** | [📚 Documentation](https://docs.livekit.io/agents/start/telephony/) | Add inbound or outbound calling to your agent |
131+
| **Telephony** | [Documentation](https://docs.livekit.io/telephony/) | Add inbound or outbound calling to your agent |
125132

126-
For advanced customization, see the [complete frontend guide](https://docs.livekit.io/agents/start/frontend/).
133+
For advanced customization, see the [complete frontend guide](https://docs.livekit.io/frontends/).
127134

128135
## Tests and evals
129136

130-
This project includes a complete suite of evals, based on the LiveKit Agents [testing & evaluation framework](https://docs.livekit.io/agents/build/testing/). To run them, use `pytest`.
137+
This project includes a complete suite of evals, based on the LiveKit Agents [testing & evaluation framework](https://docs.livekit.io/agents/start/testing/). To run them, use `pytest`.
131138

132139
```console
133140
uv run pytest
@@ -145,11 +152,11 @@ Once you've started your own project based on this repo, you should:
145152

146153
## Deploying to production
147154

148-
This project is production-ready and includes a working `Dockerfile`. To deploy it to LiveKit Cloud or another environment, see the [deploying to production](https://docs.livekit.io/agents/ops/deployment/) guide.
155+
This project is production-ready and includes a working `Dockerfile`. To deploy it to LiveKit Cloud or another environment, see the [deploying to production](https://docs.livekit.io/deploy/agents/) guide.
149156

150157
## Self-hosted LiveKit
151158

152-
You can also self-host LiveKit instead of using LiveKit Cloud. See the [self-hosting](https://docs.livekit.io/home/self-hosting/) guide for more information. If you choose to self-host, you'll need to also use [model plugins](https://docs.livekit.io/agents/models/#plugins) instead of LiveKit Inference and will need to remove the [LiveKit Cloud noise cancellation](https://docs.livekit.io/home/cloud/noise-cancellation/) plugin.
159+
You can also self-host LiveKit instead of using LiveKit Cloud. See the [self-hosting](https://docs.livekit.io/transport/self-hosting/local/) guide for more information. If you choose to self-host, you'll need to also use [model plugins](https://docs.livekit.io/agents/models/#plugins) instead of LiveKit Inference and will need to remove the [LiveKit Cloud noise cancellation](https://docs.livekit.io/transport/media/noise-cancellation/) plugin.
153160

154161
## License
155162

0 commit comments

Comments
 (0)