# Amodal

> Documentation for the Amodal Agent Runtime — build domain-specific AI agents from your repo.

## Docs

- [@amodal/chat-widget](/sdk/chat-widget): A standalone, embeddable chat widget for adding agent-powered chat to any web application. Lighter than `@amodal/react` — just the chat interface with no extra components.
- [React SDK](/sdk): Embed Amodal agents in your product with two React packages:
- [@amodal/react](/sdk/react): High-level React components for embedding Amodal agents in your product. Provides a provider, chat UI, action components, and hooks.
- [Quick Start](/quickstart/create-agent): This scaffolds an `.amodal/` directory with a config file, sample skill, and sample knowledge document. The init command is interactive — it asks for your product type and sets up appropriate templates.
- [Introduction](/quickstart/introduction): Amodal is a **git-repo-centric agent runtime**. Your agent's configuration — connections, skills, knowledge, tools, automations — lives as files in your repository. The runtime reads these files, compiles them into an optimized context, and runs a reasoning loop against any supported LLM provider.
- [Project Structure](/quickstart/project-structure): Everything that defines your agent lives in your repo root. The runtime reads these files at startup and watches for changes during development.
- [Learn](/learn): Architecture, patterns, and use cases
- [Financial Analysis](/learn/use-cases/finance): Finance teams use Amodal to **reconcile records across systems**, **explain metric anomalies**, and **monitor financial health**. The agent connects to accounting and payment systems, loads financial analysis skills, and reasons about discrepancies with precision.
- [IT Operations](/learn/use-cases/it-ops): IT operations teams use Amodal to **respond to incidents**, **scan environments for changes**, and **monitor infrastructure health**. The agent connects to cloud providers, monitoring tools, and incident management systems.
- [Security Operations](/learn/use-cases/security): Security teams use Amodal to **triage alerts**, **hunt threats**, **investigate incidents**, and **hand off across shifts**. The agent connects to security tools (SIEM, EDR, vulnerability scanners), loads security-specific skills, and reasons about findings with domain expertise.
- [Customer Support](/learn/use-cases/support): Support teams use Amodal to **gather context before responding**, **route tickets intelligently**, and **accelerate resolution** by pulling relevant information from internal systems automatically.
- [Agent Architecture](/learn/architecture/agents): Amodal uses a multi-agent architecture where a **primary agent** delegates data-intensive work to ephemeral **task agents**, keeping its own context clean for reasoning.
- [Context Management](/learn/architecture/context): The SDK provides several mechanisms to keep agent context clean and within limits, even during complex multi-step investigations.
- [The Core Loop](/learn/architecture/core-loop): Every Amodal agent runs the same fundamental loop:
- [Agents](/guide/agents): The `agents/` directory defines **custom subagents** and lets you **override built-in agents**. Each subdirectory is an agent with an `AGENT.md` file.
- [Automations](/guide/automations): Automations run your agent on a schedule or in response to webhooks. Define them in `automations/` as JSON (or Markdown).
- [amodal.json](/guide/config): The root configuration file at the repo root. Defines the agent's identity, model configuration, and platform integration.
- [Connections](/guide/connections): Each connection is a directory in `connections/` containing a spec, access rules, and optional documentation. Pre-built plugins come with everything maintained — you just provide credentials.
- [Evals](/guide/evals): Evals live in `evals/` as Markdown files. Each eval defines a query, setup context, and assertions that measure agent quality.
- [Knowledge Base](/guide/knowledge-base): Knowledge documents live in `knowledge/` as Markdown files. They teach the agent about your domain — environment, baselines, procedures, patterns.
- [MCP Servers](/guide/mcp): Amodal supports the [Model Context Protocol](https://modelcontextprotocol.io) for connecting external tool servers. MCP tools appear alongside your custom tools and platform tools — the agent uses them transparently.
- [Pages](/guide/pages): Pages are **React components** that render custom UI views in the runtime app. They live in `pages/` and use SDK hooks to read from stores, invoke skills, and display structured data. This is how you build dashboards, morning briefs, investigation views, and other composed screens.
- [Plugins](/guide/plugins): Plugins are pre-built connection packages for popular APIs. Each plugin includes API documentation, auth configuration, entity definitions, and access rules — maintained by Amodal so you just provide credentials.
- [Providers](/guide/providers): Amodal supports multiple LLM providers with a unified interface. Switch providers by changing an environment variable — no code changes needed.
- [Security & Guardrails](/guide/security): Security is built into the runtime at every layer. Six components work together to protect sensitive data and control agent behavior.
- [Skills](/guide/skills): Skills are reasoning frameworks defined as Markdown. Each skill is a directory in `skills/` containing a `SKILL.md` file.
- [Stores](/guide/stores): Stores give your agent persistent, typed data storage. Define a schema in `stores/` and the runtime auto-generates CRUD tools the agent can use.
- [Tools](/guide/tools): Custom tools live in `tools/` as directories with a handler file and optional metadata.
- [amodal chat](/cli/chat): Open an interactive terminal chat with your agent. The chat UI is a React-based TUI built with Ink.
- [amodal connect & sync](/cli/connect): Add a connection to your agent. Connections give the agent API access and documentation for external systems.
- [amodal deploy](/cli/deploy): Deploy your agent to the Amodal platform or build for self-hosting.
- [amodal dev](/cli/dev): Start a local runtime server for development. The server watches your `.amodal/` directory and hot-reloads on every change.
- [amodal eval](/cli/eval): Run evaluation suites against your agent to measure quality, compare models, and track regressions.
- [CLI](/cli): The `amodal` CLI is the primary interface for building, running, and deploying agents. Install it globally or use via `npx`:
- [amodal init](/cli/init): Initialize a new Amodal agent project. Creates the `.amodal/` directory structure with starter files based on your product type.