OpenFairyGUIFairyGUI tools for AI agents

Read, edit, validate, and publish projects through MCP, the CLI, and TypeScript SDKs for AI agents, automation scripts, and editor hosts.

Connect an Agent

Runnable Examples

Discover the installed contract

The CLI and MCP share bundled workflows, precise schemas, and diagnostic guides so agents can query the current contract before constructing operations.

Query, preview, and edit

Plan from actual properties and revisions, inspect preview impact, check revisions independently on apply/save, and report conflicts and incomplete results faithfully.

Fit your existing workflow

MCP provides stateful project editing. The CLI and Node SDKs handle inspection, publishing, and limited recovery of trusted local artifacts; browser hosts inject capabilities.

Start with a task

Ask an agent to configure a three-state reward panel, coordinating button text, interaction, and the claimed indicator. Preview the whole batch, then apply, validate, save, and reread. Getting Started moves from a connection check to the main editing task and advanced examples. The runnable example verifies SDK and real MCP edits; continue with layout and entrance animation or card generation from a template.

For scripts and editor integrations, choose CLI, Backend, or SDK entrypoints in Packages and Tools. Explore formats and public symbols through the documentation index and API Reference.

Recommended Project

FairyGUI Editor Online turns OpenFairyGUI into a ready-to-use browser-based FairyGUI project editor. It imports projects from local folders or ZIP files and supports editing, saving, publishing, and previewing directly in the browser.

Try it online · GitHub repository

Relationship to FairyGUI

OpenFairyGUI is an unofficial open-source project built around FairyGUI project formats and tooling; it is not an official FairyGUI product. The FairyGUI name, logo, and related brand assets belong to their respective owners. For official products and information, visit the FairyGUI website.