agent-starter-node AGENTS.md

Project instructions for a LiveKit Agents application, a Node.js program that builds voice-based AI agents and runs on LiveKit Cloud.

In plain words
What is it for?
Use them when installing dependencies, editing the source, running tests, formatting or linting code, and checking LiveKit documentation.
Why use it?
They give coding agents the project’s required tools, file layout, entry point, formatting rules, and documentation sources.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/livekit-examples/agent-starter-node/agents-md
Clone the repo
git clone --depth 1 https://github.com/livekit-examples/agent-starter-node

Made for: Codex, OpenCode.

Per session 1,064 This file is loaded in full into every session.
When invoked 1,064 The same file — it is already loaded in full.
Security scan C 2 findings. Scan, not verified.
Origin 88% copy Near-identical to another mod in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.01064 $0.01064
Opus 5 $0.00532 $0.00532
Sonnet 5 $0.00213 $0.00213
Haiku 4.5 $0.00106 $0.00106

Measured 2d ago against content hash 84bcf616d015, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade C, and why

agent-starter-node AGENTS.md scanned grade C with 2 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Downloads and executes remote codehighSupply chain

curl | sh runs whatever the server returns today, which is not necessarily what it returned when this was reviewed.

- **Linux:** `curl -sSL https://get.livekit.io/cli | bash`

Makes network callslowCapability

Not a fault in itself. Listed so you know the mod talks to something, and to what.

- **Linux:** `curl -sSL https://get.livekit.io/cli | bash`
Origin

This is a copy

88% identical to agent-starter-python AGENTS.md — 18 lines differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

AGENTS.md · 56 lines

How it starts

The opening of the file, as written. The whole thing — 56 lines — stays where its author put it; the contents beside it link to each section on GitHub.

AGENTS.md

This is a LiveKit Agents project. LiveKit Agents is a Node.js 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 Node.js project uses the pnpm package manager. You should always use pnpm to install dependencies, run the agent, and run tests.

All app-level code is in the src/ directory. In general, simple agents can be constructed with a single main.ts file. Additional files can be added, but you must retain main.ts as the entrypoint (see the associated Dockerfile for how this is deployed).

Be sure to maintain code formatting. You can use the prettier formatter and eslint to format and lint the code. Scripts are available in package.json, including pnpm format and pnpm lint.

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 both a CLI and an MCP server that can be used to browse and search its documentation. If the developer has not yet installed the CLI, you should recommend that they install it.

LiveKit CLI

The LiveKit CLI lk docs subcommand gives full access to LiveKit documentation from the terminal. Requires CLI version 2.15.0+. Check with lk --version.

Install or update the CLI:

  • macOS: brew install livekit-cli (update: brew update && brew upgrade livekit-cli)
  • Linux: curl -sSL https://get.livekit.io/cli | bash
  • Windows: winget install LiveKit.LiveKitCLI (update: winget upgrade LiveKit.LiveKitCLI)

Run lk docs --help to see all available commands. Key commands: lk docs overview, lk docs search, lk docs get-page, lk docs code-search, lk docs changelog, lk docs submit-feedback. Run lk docs <command> --help before using a command for the first time, as the help text includes advice on usage and interpreting results. Prefer browsing (overview, get-page) over search, and prefer search over code-search, as docs pages are more up-to-date and provide better context than raw code.

Read the full file on GitHub · 56 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 56 lines · 1,064 tokens per session scan C 84bcf616d015

Subscribe to this mod's changes

agent-starter-node AGENTS.md is an instructions file published in the GitHub repository livekit-examples/agent-starter-node (108 stars, last pushed 7d ago), licensed MIT. It adds 1,064 tokens to every session, about $0.0053 per session on Opus 5. A static security scan graded it C with 2 findings (downloads and executes remote code, makes network calls). It is 88% identical to agent-starter-python AGENTS.md, differing in 18 lines, and is treated as a copy.

Related

Other instructions, from other repositories

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,182 tokens

buildNext

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

next.js AGENTS.md

Instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens

spec-kit AGENTS.md

Instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,040 tokens

langchain AGENTS.md

Instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,345 tokens