# pagent

> Minimal async Python Agent loop over OpenAI-compatible Chat Completions. Session + tools + streaming events (native Event or JSON-RPC Wire NDJSON). Python 3.11+.

This file helps LLMs and coding agents find pagent documentation. Prefer **agent-reference** first, then topic pages.

## Documentation

- [Agent reference (read first)](https://raw.githubusercontent.com/SyncLionPaw/pagent/main/docs/agent-reference.md): Dense API cheat sheet for agents
- [Full doc bundle](https://raw.githubusercontent.com/SyncLionPaw/pagent/main/llms-full.txt): All English guides concatenated (regenerate with `cd docs && npm run build:llms`)
- [Quick start](https://raw.githubusercontent.com/SyncLionPaw/pagent/main/docs/guide/quick-start.md): Install, minimal Agent, streaming APIs
- [Providers & API keys](https://raw.githubusercontent.com/SyncLionPaw/pagent/main/docs/guide/providers.md): LLM, DeepSeek, Ollama, vLLM, SGLang
- [Prompt & session](https://raw.githubusercontent.com/SyncLionPaw/pagent/main/docs/guide/prompt.md): System prompt, Session, sliding window, compacting
- [Tools](https://raw.githubusercontent.com/SyncLionPaw/pagent/main/docs/guide/tools.md): @tool, tool loop
- [Built-in tools](https://raw.githubusercontent.com/SyncLionPaw/pagent/main/docs/guide/defaults.md): DEFAULT_TOOLS=[clock, region]; also web_search, bash, readfile
- [Memory helper](https://raw.githubusercontent.com/SyncLionPaw/pagent/main/docs/guide/memory.md): pagent.memory.Memory (experimental)
- [Events](https://raw.githubusercontent.com/SyncLionPaw/pagent/main/docs/events.md): RunBegin, TextDelta, ToolCallBegin, RunEnd, sequences
- [Wire protocol](https://raw.githubusercontent.com/SyncLionPaw/pagent/main/docs/wire.md): JSON-RPC 2.0 NDJSON for browsers and non-Python clients
- [Reasoning streams](https://raw.githubusercontent.com/SyncLionPaw/pagent/main/docs/reasoning.md): reasoning_content, ReasoningDelta
- [Wire demo](https://raw.githubusercontent.com/SyncLionPaw/pagent/main/docs/wire-demo.md): Local FastAPI + browser UI (examples/wire_browser/)
- [Developer guide](https://raw.githubusercontent.com/SyncLionPaw/pagent/main/docs/development.md): Repo layout, local dev, docs site
- [pagentv4 overview](https://raw.githubusercontent.com/SyncLionPaw/pagent/main/docs/pagentv4/index.md): Typed API with Runner, sandbox, and persistence
- [pagentv4 quick start](https://raw.githubusercontent.com/SyncLionPaw/pagent/main/docs/pagentv4/quick-start.md): run_agent, Runner, and session
- [pagentv4 core types](https://raw.githubusercontent.com/SyncLionPaw/pagent/main/docs/pagentv4/core-types.md): Agent, Runner, Message, Thread, Provider
- [pagentv4 messages](https://raw.githubusercontent.com/SyncLionPaw/pagent/main/docs/pagentv4/messages.md): Roles, chunks, multimedia mapping, OpenAI export
- [pagentv4 tools](https://raw.githubusercontent.com/SyncLionPaw/pagent/main/docs/pagentv4/tools.md): @tool, ToolOutput, sandbox tools, skills
- [pagentv4 events](https://raw.githubusercontent.com/SyncLionPaw/pagent/main/docs/pagentv4/events.md): Event stream and Runner.arun() projections
- [pagentv4 sandbox](https://raw.githubusercontent.com/SyncLionPaw/pagent/main/docs/pagentv4/sandbox.md): Companion computer, backends, Runner.session()

## Human site

- https://synclionpaw.github.io/pagent/
- https://synclionpaw.github.io/pagent/agent-reference
- https://synclionpaw.github.io/pagent/llms.txt (this file on Pages)

## Optional

- [简体中文快速开始](https://raw.githubusercontent.com/SyncLionPaw/pagent/main/docs/zh/guide/quick-start.md)
- [简体中文 pagentv4 概览](https://raw.githubusercontent.com/SyncLionPaw/pagent/main/docs/zh/pagentv4/index.md)
- [简体中文 pagentv4 快速开始](https://raw.githubusercontent.com/SyncLionPaw/pagent/main/docs/zh/pagentv4/quick-start.md)
- [日本語](https://raw.githubusercontent.com/SyncLionPaw/pagent/main/docs/ja/guide/quick-start.md)
- [四川话](https://raw.githubusercontent.com/SyncLionPaw/pagent/main/docs/sc/guide/quick-start.md)
- [README](https://raw.githubusercontent.com/SyncLionPaw/pagent/main/README.md)
- [AGENTS.md](https://raw.githubusercontent.com/SyncLionPaw/pagent/main/AGENTS.md): Instructions for coding agents in this repo