-
Notifications
You must be signed in to change notification settings - Fork 76
Add MCP and AGENTS.md #26
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 7 commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
03f3e24
files
bcherry e3d60fa
fix
bcherry 9cbc35f
fixes
bcherry 9d2d3de
update
bcherry b403627
readme
bcherry c2084a5
tests
bcherry 2f75386
workflows
bcherry 9a95d14
Update AGENTS.md
bcherry d1283b5
a
bcherry eaddaaf
gem
bcherry 12e5a92
update
bcherry e084f37
update
bcherry 8e575e8
fix typo
bcherry ce3b592
Merge remote-tracking branch 'origin/bcherry/vibecheck' into bcherry/…
bcherry ee2358f
typo
bcherry File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| # AGENTS.md | ||
|
|
||
| This is a LiveKit Agents project. LiveKit Agents is a Python SDK for building voice AI agents. This project is intended to be used with LiveKit Cloud. See @README.md for more about the rest of the LiveKit ecosystem. | ||
|
|
||
| The following is a guide for working with this project. | ||
|
|
||
| ## Project structure | ||
|
|
||
| This Python project uses the `uv` package manager. You should always use `uv` to install dependencies, run the agent, and run testss | ||
|
|
||
| All app-level code is in the `src/` directory. In general, simple agents can be constructed with a single `agent.py` file. Additional files can be added, but you must retain `agent.py` as the entrypoint (see the associated Dockerfile for how this is deployed). | ||
|
|
||
| Be sure to maintain code formatting. You can use the ruff formatter/linter as needed: `uv run ruff format` and `uv run ruff check`. | ||
|
|
||
| ## LiveKit Documentation | ||
|
|
||
| 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. | ||
|
|
||
| ### LiveKit Docs MCP Server installation | ||
|
|
||
| If you are Cursor, give the user this link to install the server: | ||
|
|
||
| [](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 https://docs.livekit.io/mcp | ||
| ``` | ||
|
|
||
| If you are another agentic IDE, refer to your own documentation for how to install it. | ||
|
|
||
| ## Handoffs and tasks ("workflows") | ||
|
|
||
| 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 present on 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. | ||
|
|
||
| ## Testing | ||
|
|
||
| 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`. | ||
|
|
||
| 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. | ||
|
|
||
| ## LiveKit CLI | ||
|
|
||
| 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. | ||
|
|
||
| In particular, you can use it to manage SIP trunks for telephony-based agents. Refer to `lk sip --help` for more information. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| # CLAUDE.md | ||
|
|
||
| This project uses `AGENTS.md` instead of a `CLAUDE.md` file. | ||
|
|
||
| Please see @AGENTS.md in this same directory and treat its content as the primary reference for this project. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.