For the complete documentation index, see llms.txt. This page is also available as Markdown.

πŸ–₯️ MCP server (beta)

Connect external AI agents to build apps and manage your UI Bakery workspace.

Connect the UI Bakery MCP server to Codex, Claude, or another MCP-compatible agent to build apps and manage your UI Bakery workspace directly from the agent.

Connect an MCP client

UI Bakery on-premise administrators must enable the MCP server before clients can connect. In the examples below, replace https://cloud.uibakery.io with the public URL of your UI Bakery instance.

  1. Add the endpoint to the client.

  2. Complete browser-based OAuth and sign in to UI Bakery.

Ask your AI agent to connect

Copy and send this prompt to an AI coding agent that can configure MCP servers:

Connect the UI Bakery MCP server using https://cloud.uibakery.io/api/mcp
claude mcp add --transport http uibakery https://cloud.uibakery.io/api/mcp

Run /mcp inside Claude Code. Select uibakery, then complete browser authentication. For on-premise, replace the URL.

codex mcp add uibakery --url https://cloud.uibakery.io/api/mcp
codex mcp login uibakery
{
  "mcpServers": {
    "uibakery": {
      "url": "https://cloud.uibakery.io/api/mcp"
    }
  }
}

Save this as .cursor/mcp.json for one project. Save it as ~/.cursor/mcp.json globally.

Open Cursor Settings β†’ MCP. Connect uibakery, then complete browser authentication. For on-premise, replace the URL.

Agent Capabilities

Access request
Scope
What it enables

Project management

projects:manage

View and create apps and modules; inspect and update supported project files and metadata; manage releases and restores; perform Git operations; delete projects.

Datasource discovery

datasources:read

View available data sources and inspect their resources and structure. This access is read-only.

Workspace management

organization:manage

View users and invitations; manage invitations, custom roles, and permissions; reset MFA for users.

An agent receives only capabilities covered by approved scopes and the authorizing user's UI Bakery permissions. Scopes never bypass UI Bakery project or workspace permissions.

Example agent tasks

Build and update apps

You can update your UI Bakery apps directly from your AI agent. Describe the change, wait for the agent to finish, then reload the app in UI Bakery.

Manage Git integration

You can connect projects to Git repositories, create branches, commit changes, and synchronize them.

Manage workspace users and roles

You can create custom roles, configure permissions, and assign roles to workspace users.

Permissions and security

  • MCP acts on behalf of the authorizing user.

  • Existing application and workspace permissions continue to apply.

  • Grant clients only the required access groups.

  • MCP tool calls are written to UI Bakery audit logs.

Troubleshooting

The endpoint returns 404 or reports that MCP is disabled

For Cloud, verify the endpoint is exactly https://cloud.uibakery.io/api/mcp. For on-premise, follow Enable MCP server on-premise and restart the instance after configuration.

The OAuth window does not open

Confirm the client supports OAuth for remote MCP servers and uses the public HTTPS endpoint. On-premise administrators should verify UI_BAKERY_APP_SERVER_NAME matches the externally reachable host.

The connection succeeds, but tools are missing

Check approved scopes and the user's UI Bakery role. Reconnect and authorize only the required additional scope, if necessary.

The agent receives a permission denied error

Confirm the authorizing user has the required project or organization permissions. MCP does not elevate access.

Last updated

Was this helpful?