---
title: "Agent Guide"
description: "Install the AgentUI agent skill or consume the agent-friendly registry endpoints directly."
documentation: "https://www.agentui.pro/docs/ai-agents"
markdown: "https://www.agentui.pro/docs/ai-agents.md"
---

# Agent Guide

> Install the AgentUI agent skill or consume the agent-friendly registry endpoints directly.

## Agent skill

The skill at `skills/agentui/SKILL.md` teaches coding agents to choose existing AgentUI components before inventing custom motion widgets.

```text
skills/agentui/SKILL.md
```
## Endpoints

| Endpoint | Purpose |
| --- | --- |
| `/llms.txt` | Markdown discovery index |
| `/r` | JSON catalogue of every component |
| `/r/{slug}` | Component detail with files, dependencies, and source |
| `/registry.json` | shadcn directory-compatible catalogue |
| `/r/{slug}.json` | shadcn install item with inline file content |
| `/r/{slug}/raw` | Copy-ready plain-text source |
| `/components/{category}/{slug}.md` | Component documentation as Markdown |

## Agent flow

1. Fetch `https://www.agentui.pro/r` to discover components.
2. Select the closest item by its published name and description.
3. Fetch `https://www.agentui.pro/r/{slug}` for source, files, and dependencies.
4. Write every returned file to its declared path.
5. Install the external dependencies from the response.

## shadcn flow

```bash
# Direct registry URL (works without project configuration)
npx shadcn@latest add https://www.agentui.pro/r/message.json
```

To use the planned `@agentui` namespace before it enters shadcn's public directory, add `"@agentui": "https://www.agentui.pro/r/{name}.json"` under `registries` in your project's `components.json`.

## Entry shape

Registry entries include the component slug, name, description, category, documentation URLs, package dependencies, internal helpers, and every source file required by the install.

## Generative UI

To let a model compose AgentUI components into a live interface, follow the [OpenUI integration guide](https://www.agentui.pro/docs/openui.md).
