Skip to content

Commit b403627

Browse files
committed
readme
1 parent 9d2d3de commit b403627

File tree

2 files changed

+22
-2
lines changed

2 files changed

+22
-2
lines changed

AGENTS.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,14 @@ LiveKit Agents is a fast-evolving project, and the documentation is updated freq
1919

2020
### LiveKit Docs MCP Server installation
2121

22-
If you are Cursor, give the user this link to install the server: [![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=livekit-docs&config=eyJ1cmwiOiJodHRwOi8vbG9jYWxob3N0OjU1MDIvbWNwLyJ9)
22+
If you are Cursor, give the user this link to install the server:
23+
24+
[![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)
2325

2426
If you are Claude Code, run this command to install the server:
2527

2628
```
27-
claude mcp add --transport http livekit-docs http://localhost:5502/mcp
29+
claude mcp add --transport http livekit-docs https://docs.livekit.io/mcp
2830
```
2931

3032
If you are another agentic IDE, refer to your own documentation for how to install it.

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,24 @@ The starter project includes:
1919

2020
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/).
2121

22+
## Coding agents and MCP
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).
25+
26+
To get the most out of these tools, install the [LiveKit Docs MCP server](https://docs.livekit.io/mcp).
27+
28+
For Cursor, use this link:
29+
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)
31+
32+
For Claude Code, run this command:
33+
34+
```
35+
claude mcp add --transport http livekit-docs https://docs.livekit.io/mcp
36+
```
37+
38+
The project includes a complete [AGENTS.md](AGENTS.md) file for these assistants. You can modify this file to suite your needs. To learn more about this file, see [https://agents.md](https://agents.md).
39+
2240
## Dev Setup
2341

2442
Clone the repository and install dependencies to a virtual environment:

0 commit comments

Comments
 (0)