Documentation

AI workflow

Every component page includes Copy AI Context — a ready-made snippet with source code, dependencies, theme tokens, and the exact npx robloxui add command.

  1. 1Open any component page and choose TSX or Luau.
  2. 2Click Copy AI Context (Markdown or JSON via the toggle).
  3. 3Paste into your AI assistant and ask it to adapt, debug, or integrate the component.
  4. 4The snippet includes npx robloxui add <slug> so your assistant knows how to install it.

Roblox Studio MCP workflow

If your AI client supports the Model Context Protocol (MCP), connect a Roblox Studio MCP server in that client and open the generated project as its workspace. Keep the project source, not Studio, as the source of truth:

  1. Start the project build watcher and Rojo from the project root.
  2. Connect the Rojo Studio plugin, then connect your MCP client to Studio.
  3. Ask the assistant to inspect or change source files and explain the intended Studio result.
  4. Run the build and Rojo sync before testing the change in Play mode.

MCP server configuration is client-specific. Do not commit API keys or local MCP credentials; use the server's official setup instructions and grant only the workspace access it needs.

Bring your AI assistant up to speed

Download a project rules file so Cursor, Windsurf, or GitHub Copilot knows RobloxUI's CLI, flavors, and theme tokens. Drop it in your repo and your assistant will follow these conventions project-wide.

Save to your project root (or .cursor/rules/ for .mdc, .github/ for Copilot).