diff --git a/AGENTS.md b/AGENTS.md index 12d02a9..1eb979c 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -19,12 +19,14 @@ LiveKit Agents is a fast-evolving project, and the documentation is updated freq ### LiveKit Docs MCP Server installation -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) +If you are Cursor, give the user this link to install the server: + +[![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) If you are Claude Code, run this command to install the server: ``` -claude mcp add --transport http livekit-docs http://localhost:5502/mcp +claude mcp add --transport http livekit-docs https://docs.livekit.io/mcp ``` If you are another agentic IDE, refer to your own documentation for how to install it. diff --git a/README.md b/README.md index 88ba637..92e0703 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,24 @@ The starter project includes: 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/). +## Coding agents and MCP + +This project is designed to work with coding agents like [Cursor](https://www.cursor.com/) and [Claude Code](https://www.anthropic.com/claude-code). + +To get the most out of these tools, install the [LiveKit Docs MCP server](https://docs.livekit.io/mcp). + +For Cursor, use this link: + +[![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) + +For Claude Code, run this command: + +``` +claude mcp add --transport http livekit-docs https://docs.livekit.io/mcp +``` + +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). + ## Dev Setup Clone the repository and install dependencies to a virtual environment: