mirror of
https://github.com/livekit/agent-skills.git
synced 2026-09-14 20:06:59 +08:00
8e7c931b83
Co-authored-by: Topher Hindman <topher.hindman@livekit.io>
2.1 KiB
2.1 KiB
AGENTS.md
This repository contains AI agent skills for building with LiveKit. The skills follow the Agent Skills format.
Repository Structure
agent-skills/
├── README.md # User-facing documentation
├── AGENTS.md # This file (for AI agents)
├── CLAUDE.md # Points to AGENTS.md
└── skills/
├── livekit-agents/ # LiveKit Agents skill
│ ├── SKILL.md # The skill content
│ └── references/ # Supporting documentation
└── livekit-simulations/ # LiveKit Simulations skill
├── SKILL.md # The skill content
├── references/ # Supporting documentation
└── scripts/ # Supporting scripts
Contributing Guidelines
Skill Content Principles
All skills in this repository must follow the "freeze forever" principle:
- Encode behavior, not knowledge - Skills teach how to approach problems, not API specifics
- Direct to MCP for facts - All factual information must come from live documentation
- Require testing - Every agent implementation must include tests
- Stay under 500 lines - Keep skills concise for context efficiency
SKILL.md Format
Each skill requires YAML frontmatter:
---
name: skill-name-kebab-case
description: Trigger phrases and brief description. Include phrases like "build a voice agent" that help agents recognize when to use this skill.
license: MIT
metadata:
author: livekit
version: "X.Y.Z"
---
File Naming
- Skill directories use
kebab-case SKILL.mdis the only uppercase filename- Supporting docs go in
references/subdirectory
LiveKit MCP Server
These skills are designed to work with the LiveKit Docs MCP server. If you're working on this repository and need to test MCP integration, make sure it is installed. Installation instructions are available at https://docs.livekit.io/intro/mcp-server/