42 lines
2.7 KiB
Markdown
42 lines
2.7 KiB
Markdown
# 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 (e.g. library code), 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=eyJ1cmwiOiJodHRwOi8vbG9jYWxob3N0OjU1MDIvbWNwLyJ9)
|
|
|
|
If you are Claude Code, run this command to install the server:
|
|
|
|
```
|
|
claude mcp add --transport http livekit-docs http://localhost:5502/mcp
|
|
```
|
|
|
|
If you are another agentic IDE, refer to your own documentation for how to install it.
|
|
|
|
## 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.
|
|
|
|
Important: When modifying core agent behavior such as instructions, tool descriptions, and tasks/workflows/handoffs, never make guesses about 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. |