ggui-ai/ggui

GGUI는 AI 에이전트와 인간 사용자 간의 실행 시간 협상 데이터 계약을 위한 개방형 프로토콜입니다.

· 공지사항

Public 미리보기 - pre-1.0. 모든 32 @ggui-ai/*] Lockstep minor 파도의 패키지 배송 - 아래의 배지가 현재 하나 표시; 프로토콜은 초안이며 여전히 파도 사이에 변경할 수 있습니다. Pin 정확한 버전 (아래 배지 참조) 및 각 파의 노트에 대한 릴리스; v1.0 프로토콜을 동결.

---

에이전트는 자연 언어에 필요한 것을 설명합니다. GGUI는 MCP에 ephemeral, 대화 형 인터페이스를 생성합니다. 프론트엔드 코드, React 템플릿 없음, 사용자 정의 구성 요소 없음 — Agent Talk, user see UI.

이 repo는 ** 오픈 프로토콜 + 참조 런타임 **입니다. ggui serve; 어떤 MCP-aware 에이전트 실행에 대한 쌍 (Claude Desktop, Claude Code, claude.ai, Cursor, ChatGPT 데스크탑, Goose, 당신의 자신의). Zero 계정 필수, 0 관리 인프라 필요, 0 클라우드 의존성.

---

빠른 시작 — 당신의 길을 선택

##1. 황금길 - platform-composed (guuey-sdk)

guuey.json]에서 렌더링, 대화 형 todo UI로 한 흐름을 - 게시된 SDK를 모든 조각.

GGUI is an open protocol for generative UI — a runtime-negotiated data contract between AI agents and human users.

Docs · Releases

🚧 Public preview — pre-1.0. All 32 @ggui-ai/* packages ship in lockstep minor waves — the badges below show the current one; the protocol is a draft and may still change between waves. Pin exact versions (see badges below) and watch Releases for each wave’s notes; v1.0 marks the protocol freeze.

---

Agents describe what they need in natural language; GGUI generates ephemeral, interactive interfaces over MCP. No frontend code, no React templates, no custom components — agents talk, users see UI.

This repo is the open protocol + reference runtime. Self-host with ggui serve; pair against any MCP-aware agent runtime (Claude Desktop, Claude Code, claude.ai, Cursor, ChatGPT desktop, Goose, your own). Zero account required, zero managed infrastructure required, zero cloud dependency.

---

Quick start — pick your path

1. Composed golden path — platform-composed (guuey-sdk)

One flow from a guuey.json to a rendered, interactive todo UI — every piece a published SDK. guuey’s dev tooling runs the agent (@guuey/cli + @guuey/worker), the GGUI runtime is the dev router’s injected MCP default, and the web client talks to the router with @guuey/agent-client. This path is platform-composed: it drives the GGUI protocol through guuey’s published SDKs. The protocol itself has no guuey dependency — paths 2–4 run without it, and the framework-native samples (path 2) stay first-class.

Prerequisites: Node.js 22+, pnpm, and an ANTHROPIC_API_KEY (one key drives both the agent and GGUI’s UI generation).

git clone https://github.com/ggui-ai/ggui && cd ggui
pnpm install                        # workspace deps — `guuey dev` spawns the colocated
                                    # todo MCP from samples/mcp-servers/todo
export ANTHROPIC_API_KEY=sk-ant-…   # in every terminal below

# terminal 1 — the ggui runtime MCP (guuey's dev router injects ggui → this port).
# --dev-allow-all admits the bearer-less local callers (the router's ggui
# connection and the web page's relay). Local dev only.
npx -y @ggui-ai/cli serve --mcp-only --dev-allow-all   # http://127.0.0.1:6781/mcp

# terminal 2 — the agent half: guuey.json + a Claude agent worker
cd samples/agents/with-guuey
npm install
npm run dev                              # guuey dev --serve → http://localhost:6790

# terminal 3 — the web half: chat + rendered ggui cards