# ACP Kit

Published docs base URL: https://vcoderun.github.io/acpkit/

ACP Kit is a Python SDK and CLI that turns an existing agent surface into a truthful ACP server boundary.
Today the primary production surface is `pydantic-acp`, which adapts `pydantic_ai.Agent` without inventing ACP state the runtime cannot actually honor.

## Documentation Index

### Overview

- [ACP Kit](https://vcoderun.github.io/acpkit/)
  Source: `docs/index.md`
  Summary: Product overview, package map, truthful ACP exposure, and recommended reading order.

### Getting Started

- [Installation](https://vcoderun.github.io/acpkit/getting-started/installation/)
  Source: `docs/getting-started/installation.md`
  Summary: Production and development installation paths for the root package and optional extras.
- [Quickstart](https://vcoderun.github.io/acpkit/getting-started/quickstart/)
  Source: `docs/getting-started/quickstart.md`
  Summary: Smallest runnable path from a normal Pydantic AI agent to an ACP server.
- [CLI](https://vcoderun.github.io/acpkit/cli/)
  Source: `docs/cli.md`
  Summary: Target resolution, acpkit run and launch semantics, and failure modes.

### Core Docs

- [Pydantic ACP Overview](https://vcoderun.github.io/acpkit/pydantic-acp/)
  Source: `docs/pydantic-acp.md`
  Summary: Adapter purpose, construction seams, and when to reach for each runtime integration path.
- [AdapterConfig](https://vcoderun.github.io/acpkit/pydantic-acp/adapter-config/)
  Source: `docs/pydantic-acp/adapter-config.md`
  Summary: Field-by-field guide to runtime configuration, ownership, and adapter behavior.
- [Session State and Lifecycle](https://vcoderun.github.io/acpkit/pydantic-acp/session-state/)
  Source: `docs/pydantic-acp/session-state.md`
  Summary: Session stores, replay semantics, persistence, and state transitions.
- [Models, Modes, and Slash Commands](https://vcoderun.github.io/acpkit/pydantic-acp/runtime-controls/)
  Source: `docs/pydantic-acp/runtime-controls.md`
  Summary: Model selection, dynamic mode switching, thinking effort, and slash command semantics.
- [Plans, Thinking, and Approvals](https://vcoderun.github.io/acpkit/pydantic-acp/plans-thinking-approvals/)
  Source: `docs/pydantic-acp/plans-thinking-approvals.md`
  Summary: Native plan state, approval flows, cancellation, and thinking capability behavior.
- [Prompt Resources and Context](https://vcoderun.github.io/acpkit/pydantic-acp/prompt-resources/)
  Source: `docs/pydantic-acp/prompt-resources.md`
  Summary: Resource links, embedded context, Zed selections, branch diffs, and multimodal prompt input behavior.
- [Providers](https://vcoderun.github.io/acpkit/providers/)
  Source: `docs/providers.md`
  Summary: Host-owned models, modes, config, plan persistence, and approval metadata patterns.
- [Bridges](https://vcoderun.github.io/acpkit/bridges/)
  Source: `docs/bridges.md`
  Summary: Capability bridges for prepare-tools, thinking, hooks, MCP metadata, and history processors.
- [Host Backends and Projections](https://vcoderun.github.io/acpkit/host-backends/)
  Source: `docs/host-backends.md`
  Summary: Client-backed filesystem, terminal execution, and projection map rendering.
- [Helpers](https://vcoderun.github.io/acpkit/helpers/)
  Source: `docs/helpers.md`
  Summary: Codex auth helper package and supported Codex-backed Pydantic AI model construction.

### Examples

- [Examples Overview](https://vcoderun.github.io/acpkit/examples/)
  Source: `docs/examples/index.md`
  Summary: Maintained example set with two broad, production-shaped ACP examples and their reading order.
- [Finance Agent](https://vcoderun.github.io/acpkit/examples/finance/)
  Source: `docs/examples/finance.md`
  Summary: Session-aware finance workspace with ACP plans, approvals, mode-aware tool shaping, and projected note diffs.
- [Travel Agent](https://vcoderun.github.io/acpkit/examples/travel/)
  Source: `docs/examples/travel.md`
  Summary: Travel planning runtime with hook projection, approval-gated trip files, and prompt-model override behavior for media prompts.

### API Reference

- [acpkit API](https://vcoderun.github.io/acpkit/api/acpkit/)
  Source: `docs/api/acpkit.md`
  Summary: API reference for the root CLI package and target resolution helpers.
- [pydantic_acp API](https://vcoderun.github.io/acpkit/api/pydantic_acp/)
  Source: `docs/api/pydantic_acp.md`
  Summary: API reference for the adapter package, session stores, providers, bridges, and helpers.
- [codex_auth_helper API](https://vcoderun.github.io/acpkit/api/codex_auth_helper/)
  Source: `docs/api/codex_auth_helper.md`
  Summary: API reference for Codex auth state, client construction, and Responses model helpers.

### Operations

- [Testing](https://vcoderun.github.io/acpkit/testing/)
  Source: `docs/testing.md`
  Summary: Canonical validation commands, coverage entry points, and test style guidance.
- [About ACP Kit](https://vcoderun.github.io/acpkit/about/)
  Source: `docs/about/index.md`
  Summary: Design goals, intended audience, package scope, and project status.
