Skip to content

agent-ui.mdx

Latest commit

 

History

History
155 lines (108 loc) · 5.22 KB

agent-ui.mdx

File metadata and controls

155 lines (108 loc) · 5.22 KB
title Agent UI
description Run AI agents locally on your PC through a desktop interface
icon desktop

GAIA Agent UI is a desktop interface for running AI agents 100% locally on your AMD hardware. Use agents to analyze documents, generate code, answer questions, and accomplish tasks on your PC — all without sending data to the cloud.

**Ready to install?** See the [Quickstart](/quickstart#agent-ui-fastest) for installation instructions.

What You Can Do

Search and Browse Files

The agent has access to your local file system. Ask it to find files, explore directories, or locate specific content across your projects — no manual browsing required.

Analyze Documents

Once the agent finds files — or you drag them into a session — it can index and analyze their content. Ask it to summarize, compare, extract data, or answer questions about any supported format:

  • Documents: PDF, Word, PowerPoint, Excel, TXT, Markdown, CSV, JSON, HTML, XML, YAML
  • Code: Python, JavaScript, TypeScript, Java, C/C++, Go, Rust, Ruby, Shell
  • Config: INI, CFG, TOML, YAML, JSON, XML

Session Management

Create, rename, search, export (Markdown/JSON), and delete sessions. Sessions persist across the CLI (gaia chat) and the Agent UI.

Keyboard Shortcuts

Shortcut Action
Enter Send task / message
Shift+Enter New line
Escape Stop agent response
Ctrl+K Focus sidebar search

MCP Server

The Agent UI includes a built-in MCP (Model Context Protocol) server that exposes the full Agent UI as a set of tools. This lets external AI assistants — like Claude Code, Cursor, or any MCP-compatible client — interact with GAIA agents through the same backend that powers the web UI.

Conversations initiated via MCP appear in the browser UI in real time, so you can watch tool execution and agent activity as it happens.

The MCP server provides 15 tools for managing sessions, sending messages, indexing documents, browsing files, and more.

See the Agent UI MCP Server guide for setup instructions and usage examples.

Troubleshooting

```bash lemonade-server serve ``` 
If not installed, run `gaia init --profile minimal` or follow the [Setup Guide](/setup).
```bash gaia download --agent chat ``` ```bash gaia --ui --ui-port 8080 ``` Close any other GAIA Agent UI or CLI instances. Only one writer at a time is supported. - Ensure the file is a supported format and not password-protected - Keep file size under 100MB - For PDF image extraction, download the VLM model: `gaia download --agent chat`

Architecture

%%{init: {'theme':'base', 'themeVariables': { 'primaryColor':'#ED1C24', 'primaryTextColor':'#fff', 'primaryBorderColor':'#C8171E', 'lineColor':'#F4484D', 'secondaryColor':'#2d2d2d', 'tertiaryColor':'#f5f5f5', 'fontFamily': 'system-ui, -apple-system, sans-serif'}}}%%
flowchart TD
    A(["Agent UI (Browser or Electron)"]) --> B(["FastAPI Backend · port 4200"])
    B --> C(["GAIA Core SDKs"])
    C --> D(["Lemonade Server · port 8000"])

    B -.- E(["REST API + SSE Streaming"])
    B -.- F(["SQLite Database"])
    C -.- G(["Agent · RAGSDK · LemonadeClient"])
    D -.- H(["Model Serving (NPU / iGPU)"])

    style A fill:#f8f9fa,stroke:#dee2e6,stroke-width:2px,color:#495057
    style B fill:#ED1C24,stroke:#C8171E,stroke-width:2px,color:#fff
    style C fill:#F4484D,stroke:#ED1C24,stroke-width:2px,color:#fff
    style D fill:#2d2d2d,stroke:#1a1a1a,stroke-width:2px,color:#fff
    style E fill:#f8f9fa,stroke:#dee2e6,stroke-width:1px,color:#6c757d
    style F fill:#f8f9fa,stroke:#dee2e6,stroke-width:1px,color:#6c757d
    style G fill:#f8f9fa,stroke:#dee2e6,stroke-width:1px,color:#6c757d
    style H fill:#f8f9fa,stroke:#dee2e6,stroke-width:1px,color:#6c757d

    linkStyle 0,1,2 stroke:#ED1C24,stroke-width:2px
    linkStyle 3,4,5,6 stroke:#dee2e6,stroke-width:1px,stroke-dasharray:5
Loading

For the REST API reference and backend classes, see the Agent UI SDK Reference.

Next Steps

REST endpoints, database schema, and Python backend API CLI-based document agent with RAG, debug mode, and chunking strategies Create a custom agent with tools in minutes Connect Claude Code, Cursor, or any MCP client to the Agent UI

License

Copyright(C) 2024-2026 Advanced Micro Devices, Inc. All rights reserved.

SPDX-License-Identifier: MIT