---
title: "Agent Guide"
description: "Install the beUI agent skill, connect the MCP server, or consume the agent-friendly registry endpoints directly."
documentation: "https://beui.dev/docs/ai-agents"
markdown: "https://beui.dev/docs/ai-agents.md"
---

# Agent Guide

> Install the beUI agent skill, connect the MCP server, or consume the agent-friendly registry endpoints directly.

## Agent skill

Install the skill when you want coding agents to choose existing beUI components before inventing custom motion widgets.

```bash
npx skills add starc007/ui-components --skill beui
```

## MCP server

Connect the hosted beUI MCP server at `https://mcp.beui.dev/mcp`.

```bash
# Claude Code
claude mcp add --transport http beui https://mcp.beui.dev/mcp

# Codex
codex mcp add beui --url https://mcp.beui.dev/mcp

# Amp
amp mcp add beui https://mcp.beui.dev/mcp
```

Manual configuration:

```json
{
  "mcpServers": {
    "beui": {
      "type": "http",
      "url": "https://mcp.beui.dev/mcp"
    }
  }
}
```

Available tools: `list_components`, `search_components`, `get_component`, and `get_install_command`.

## 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://beui.dev/r` to discover components.
2. Select the closest item by its published name and description.
3. Fetch `https://beui.dev/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
# Official registry namespace
npx shadcn@latest add @beui/animated-toast-stack

# Direct registry URL
npx shadcn@latest add https://beui.dev/r/animated-toast-stack.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 beUI components into a live interface, follow the [OpenUI integration guide](https://beui.dev/docs/openui.md).