MCP server

The Subframe MCP server gives AI coding assistants like Claude Code, Cursor, and Codex direct access to your Subframe projects. AI can read, design, and delete pages, components, and snippets, screenshot pages and components, read prototypes, write design documents, edit the theme, and search the Subframe docs. A separate Subframe Docs MCP server gives AI access to Subframe documentation (this site).

Installation

Claude Code
Claude Desktop
Cursor
Codex
Other clients

Install the Subframe plugin

claude plugin marketplace add https://github.com/SubframeApp/subframe && claude plugin install subframe@subframe

The Subframe plugin for Claude Code sets up the MCP server and agent skills in one install.

Enable auto-update (recommended)

Keep the Subframe plugin up to date automatically:

Run /plugin to open the plugin manager
Select the Marketplaces tab
Choose the subframe marketplace
Select Enable auto-update

Verify installation

Run /mcp to check that the Subframe MCP server is connected, then try asking Claude Code to use Subframe.

Create your first design

Follow the Working with AI agents guide to design and implement your first page.

Add the Subframe connector

Go to Customize > Connectors
Click and select Add custom connector
Set the name to Subframe
For Remote MCP Server URL, paste the following URL:
https://mcp.subframe.com/mcp
Click Add

Authenticate

Find the Subframe connector in your connectors list and click Connect. Follow the instructions on the Subframe website to complete authentication.

Create your first design

Follow the Working with AI agents guide to design and implement your first page.

Install MCP servers

Add the Subframe MCP servers to Cursor. You’ll be prompted to authenticate via OAuth.

Troubleshooting: Manual installation

If the install links don’t work, make the following changes to ~/.cursor/mcp.json.

~/.cursor/mcp.json

{
  "mcpServers": {
    "subframe": {
      "url": "https://mcp.subframe.com/mcp"
    },
    "subframe-docs": {
      "url": "https://docs.subframe.com/mcp"
    }
  }
}

Cursor will handle OAuth authentication automatically when you first connect.

Install agent skills

Agent skills are guided workflows that teach Cursor how to best use Subframe. Install them with:

npx skills add https://github.com/SubframeApp/subframe --skill '*' -g --agent cursor --yes

Verify installation

Check that the Subframe MCP server has successfully connected in Cursor Settings > MCP, then try asking Cursor to use Subframe.

Create your first design

Follow the Working with AI agents guide to design and implement your first page.

Install MCP servers

Run the following commands to add the Subframe MCP servers and authenticate:

codex mcp add subframe --url https://mcp.subframe.com/mcp && codex mcp add subframe-docs --url https://docs.subframe.com/mcp && codex mcp login subframe

Troubleshooting: Manual installation

If the commands above don’t work, add the following to ~/.codex/config.toml:

~/.codex/config.toml

[mcp_servers.subframe]
url = "https://mcp.subframe.com/mcp"

[mcp_servers.subframe-docs]
url = "https://docs.subframe.com/mcp"

Then authenticate:

codex mcp login subframe

Install agent skills

Agent skills are guided workflows that teach Codex how to best use Subframe. Install them with:

npx skills add https://github.com/SubframeApp/subframe --skill '*' -g --agent codex --yes

Verify installation

Run /mcp in Codex to check that the Subframe MCP server is connected, then try asking Codex to use Subframe.

Create your first design

Follow the Working with AI agents guide to design and implement your first page.

Configure the Subframe MCP Server

Configure your MCP client to connect to the Subframe MCP server:

URL: https://mcp.subframe.com/mcp
Transport: HTTP
Authentication: OAuth (your client will handle the authentication flow)

Configure the Subframe Docs MCP Server (optional)

Optionally add the Subframe Docs MCP server for documentation access:

URL: https://docs.subframe.com/mcp
Transport: HTTP
Authentication: None required

Install agent skills (optional)

If your client supports the Agent Skills standard, install the Subframe skills with:

npx skills add https://github.com/SubframeApp/subframe --skill '*' --agent '*' --yes

Verify installation

Restart your MCP client, then check that the Subframe MCP server has successfully connected and try asking your AI assistant to use Subframe.

Create your first design

Follow the Working with AI agents guide to design and implement your first page.

Using the MCP server

Once configured, your AI assistant can access Subframe automatically when you prompt or paste an MCP link to a page from the Code panel. You can get the MCP link for any design by either:

Copying the link from the browser address bar
Copying the link under Code > Inspect in Subframe

Available tools

The Subframe MCP server exposes tools across several categories. Most read tools take a projectId. If omitted, the first project the user has access to is used.

Discovery

Tool	Description	Returns
`list_projects`	Lists all projects you have access to	Array of `projectId`, `name`, `teamId`, `teamName`
`generate_auth_token`	Generates a CLI auth token for a team	`authToken`
`get_project_info`	Project metadata plus all project-level design documents	`id`, `name`, `docs` (array of `id`, `title`, `contents`)
`search_docs`	Searches the Subframe documentation (this site) for product and workflow questions	`results` (matching documentation content with titles and links)

Pages

Tool	Description	Key inputs	Returns
`list_pages`	List all pages with the flow each belongs to	`projectId`	Array of `id`, `name`, `url`, `lastModifiedAt`, `flowId`, `flowName`
`get_page_info`	Generated React/Tailwind code for a page. Pass `includeNodeIds: true` to get a `data-node-id` on every element for use with `edit_page`	`id`/`name`/`url`, `projectId`, `includeNodeIds?`	`id`, `name`, `lastModifiedAt`, `files`
`design_page`	Generates 1-4 page variations as an asynchronous background job. Successful variations land as pages in a flow as they finish; `wait_for_jobs` reports how many were applied	`description`, `variations`, `flowName`, `projectId`, `references?`, `sourcePageId?`	`flowId`, `flowUrl`, `jobId`
`edit_page`	Apply a targeted edit to one node of an existing page — `replace` the node and its subtree, `insert-above`/`insert-below` a new sibling, or `delete` it. Call `get_page_info` with `includeNodeIds: true` first to get each element’s `data-node-id`. Applied immediately; `appliedCode` carries each element’s `data-node-id` for follow-up edits	`id`/`name`/`url`, `nodeId`, `operation`, `code`, `projectId`	`pageUrl`, `appliedCode?`, `warnings?`
`screenshot_page`	Renders a page and returns a screenshot so AI can check the result against the intended design. Use after `design_page`/`edit_page`, once background jobs finish. Pass `nodeId` (from `get_page_info` with `includeNodeIds: true`) to capture one element, `breakpointId` (from `get_theme`) to render a responsive breakpoint, or `offsetX`/`offsetY` to cover a page taller or wider than one capture	`id`/`name`/`url`, `projectId`, `darkMode?`, `nodeId?`, `breakpointId?`, `offsetX?`, `offsetY?`	Screenshot image, `pageId`, `width`, `height`
`delete_page`	Delete a page, removing it from its flow and stripping prototype actions referencing it. Refuses by default if referenced in other pages. Use `force: true` to delete anyway	`id`/`name`/`url`, `projectId`, `force?`	`deletedId`, `deletedName`, `references`

Components

Tool	Description	Key inputs	Returns
`list_components`	List all components	`projectId`	Array of `id`, `name`, `url`, `lastModifiedAt`
`get_component_info`	Generated code plus attached design document	`id`/`name`/`url`, `projectId`	`id`, `name`, `lastModifiedAt`, `files`, `designDocuments`
`screenshot_component`	Renders a component’s variants and interaction states and returns a screenshot so AI can validate the result against the intended design. Use after `design_component`/`edit_component`, once background jobs finish. Pass `breakpointId` (from `get_theme`) to render a responsive breakpoint	`id`/`name`/`url`, `projectId`, `darkMode?`, `breakpointId?`	Screenshot image, `componentId`, `width`, `height`
`design_component`	Designs a new component as an asynchronous background job	`description`, `name`, `projectId`, `references?`	`componentId`, `componentUrl`, `jobId`
`edit_component`	Edit an existing component as an asynchronous background job. Propagates to every page using the component	`id`/`name`/`url`, `description`, `projectId`, `references?`	`componentUrl`, `jobId`
`delete_component`	Delete a component or custom page layout. Detachable components detach their instances; non-detachable ones delete instances; page layouts clear assignments. Some built-in components can’t be deleted (`force` does not override). Refuses by default if in use — pass `force: true` to delete anyway	`id`/`name`/`url`, `projectId`, `force?`	`deletedId`, `deletedName`, `references`

Snippets

Snippets are small, standalone bits of UI typically embedded inside design documents as live examples (e.g. a “Button variants” snippet showing every Button state). They live within Subframe and do not sync out.

Tool	Description	Key inputs	Returns
`list_snippets`	List all snippets	`projectId`	Array of `id`, `name`, `url`, `lastModifiedAt`
`get_snippet_info`	Generated code for a snippet. Pass `includeNodeIds: true` to get a `data-node-id` on every element for use with `edit_snippet`	`id`/`name`/`url`, `projectId`, `includeNodeIds?`	`id`, `name`, `lastModifiedAt`, `files`
`design_snippet`	Design a new snippet	`description`, `name?`, `projectId`, `references?`	`snippetId`, `snippetUrl`
`edit_snippet`	Apply a targeted edit to one node of an existing snippet (same model as `edit_page`). Call `get_snippet_info` with `includeNodeIds: true` first	`id`/`name`/`url`, `nodeId`, `operation`, `code`, `projectId`	`snippetUrl`, `appliedCode?`, `warnings?`
`delete_snippet`	Delete a snippet. Any design document embeds are removed automatically	`id`/`name`/`url`, `projectId`	`deletedId`, `deletedName`

Flows

A flow is a collection of related pages (e.g. “Onboarding”, “Checkout”).

Tool	Description	Key inputs	Returns
`list_flows`	List all flows	`projectId`	Array of `id`, `name`, `pageCount`
`get_flow_info`	A flow with its name and ordered pages	`id`/`name`/`url`, `projectId`	`id`, `name`, `pages`
`delete_flow`	Delete a flow. Refuses if it contains pages. Use `deleteChildPages: true` to delete the flow plus every page inside it	`id`/`name`/`url`, `projectId`, `deleteChildPages?`	`deletedId`, `deletedName`, `deletedPageIds`

Prototypes

A prototype is an interactive, AI-built running app — its own React + Vite codebase — created in the Subframe prototyping editor. The read tools below expose a prototype as a standalone, runnable Vite app: internal scaffolding is dropped and the Vite/Tailwind config plus an entrypoint are added, so the file paths and contents you get back are ready to run with npm install && npm run dev.

Tool	Description	Key inputs	Returns
`list_prototypes`	List all prototypes in a project	`projectId`	Array of `id`, `name`, `lastModifiedAt`
`get_prototype_info`	A prototype’s metadata and the list of files in its runnable Vite app	`id`, `projectId`	`id`, `name`, `lastBuiltAt`, `files`
`read_prototype_file`	Read the contents of a single file from a prototype’s runnable Vite app	`id`, `filePath`, `projectId`	`id`, `filePath`, `contents`

Design documents

Design documents are markdown files that convey how to work within your design system — brand voice, design principles, component usage rules (“when to use Toggle vs. Checkbox”), accessibility requirements, do/don’t examples. AI automatically reads them when designing or implementing. Project-scoped docs (many per project) cover broad guidance; component-scoped docs (one per component, attached directly to it) cover specifics for that component.

Tool	Description	Key inputs	Returns
`write_design_document`	Create or update a markdown design document. Project-scoped if no `componentId`; component-scoped otherwise. Snippet examples can be embedded like so `<div data-type="component-example" data-component-id="..."></div>`	`content`, `id?`, `componentId?`, `title?`, `projectId`, `mode?` (`replace`/`append`)	`documentId`, `documentUrl`

Read existing docs first via get_project_info (project-level) or get_component_info (component-level). When updating, always pass the existing id — components allow at most one design document, and creating a second is rejected.

Theme

Tool	Description	Key inputs	Returns
`get_theme`	Generate the Tailwind theme for the project	`projectId`, `cssType?`	`theme` config
`edit_theme`	Edits the project’s visual theme (colors, fonts, corners, shadows, typography) from a natural-language prompt. Applies immediately to the whole project. Supports adding tokens, changing token values, renaming tokens, and deleting tokens (destructive — references in designs are replaced with the token’s concrete value at deletion time).	`description`, `projectId`	`themeUrl`
`search_icons`	Search the project’s icon library by describing what you want (e.g. “warning triangle”, “shopping cart”). Icon sets vary by project, so use this to find real names rather than assuming a set — reference a result’s exact name in the code you pass to `edit_page`, `edit_snippet`, or a design tool	`query`, `projectId?`	`iconLibraryStatus`, `iconLibrarySize`, `icons` (array of `name`, `hints`)

Design references

design_page, design_component, edit_component, and design_snippet accept an optional references array that grounds the generation in real material. Each entry pairs a source with a usage note telling the generator how to use that reference:

{
  "source": { "kind": "subframe", "id": "..." },
  "usage": "Match this page's layout and header"
}

Source kind	Shape	Use for
`subframe`	`{ "kind": "subframe", "id": "..." }`	An existing page, component, or snippet in the project, by ID or name. Resolved server-side — no need to inline its code
`code`	`{ "kind": "code", "content": "..." }`	Raw code from your codebase: a surface to recreate, data types/interfaces, or usage patterns
`image`	`{ "kind": "image", "url": "..." }`	A mockup or screenshot uploaded to Subframe. Only Subframe upload URLs work — external URLs are rejected — and up to 5 images are used per call

Invalid references are dropped with a warning in the tool result rather than failing the design.

Async jobs

Tool	Description	Key inputs	Returns
`wait_for_jobs`	Wait for background AI jobs to finish. Each result is `running`, `done` (finished with at least one usable result — for `design_page` the summary reports how many pages were applied), `error` (the job failed, produced nothing, or stopped reporting — check the summary and don’t assume the edit happened), or `not_found`. Call in a loop until every job is `done` or `error`	`jobIds` (1-10)	Array of `jobId`, `status` (`running`/`done`/`error`/`not_found`), `summary?`

design_page, design_component, and edit_component return a jobId alongside their URL. The URL can be used immediately to view the real-time progress of the job in the editor. Pass the jobId(s) to wait_for_jobs before reading back the generated content with get_page_info, get_component_info, get_snippet_info, or get_flow_info — those reads return empty/stale state until the job is done.

Prompt with MCP link

When prompting we recommend using the MCP link found in the Code Inspect panel for a page.

Implement the design at https://app.subframe.com/design/...

To get the latest version of components in your project, run npx @subframe/cli@latest sync to sync components.

Example prompts

Implement a new page from a design

Create a new page using the Subframe page at
https://app.subframe.com/PROJECT_ID/design/DESIGN_ID/edit as reference.

Wire up relevant app logic (API calls, hooks, routing) where applicable.
Keep it consistent with existing project conventions.

Update an existing page with a new design

Update the existing page to match the Subframe design at
https://app.subframe.com/PROJECT_ID/design/DESIGN_ID/edit.

Preserve all existing functionality unless the new design requires a change.

Design a new component

Design a PrivacyToggle component in Subframe. It should have an on/off state,
a label, and a description below the label. Use the same toggle styling as
our existing Toggle component.

Write a design document

Write a design doc for the Toggle component covering when to use it,
accessibility considerations, and a snippet showing all variants.

Delete unused components

List the components in my Subframe project and help me delete any that
aren't being used in any pages.

Add accessibility tags in code

Review the Subframe design at
https://app.subframe.com/PROJECT_ID/design/DESIGN_ID/edit and add proper
accessibility attributes to the existing page.

Add ARIA labels, roles, and descriptions, and proper semantic HTML throughout.

Migrate to Subframe's design system

Migrate the components on the existing page to use Subframe components instead
of the old components.

Get all components in my Subframe project and preserve all existing
functionality unless the new design requires a change.

Fetch a component

Get the Button component from Subframe and use it in this file.

List available components

Show me all components in my Subframe project.

Get the theme

Get my Subframe theme configuration.

Troubleshooting

Authentication failed

The Subframe MCP server uses OAuth. If you’re seeing authentication errors:

Try re-authenticating by reconnecting to the MCP server in your client
Check that you have the correct permissions for the project you’re trying to access
Make sure your browser session is active when authenticating
Confirm your client supports MCP OAuth — Subframe access tokens are not accepted by the MCP server

AI not calling the server

Make sure your AI tool:

Has MCP support enabled
Has the Subframe server in its MCP configuration
Has been restarted after adding the configuration

Check your tool’s logs for MCP-related errors.

Component or page not found

Use list_components, list_pages, list_snippets, or list_flows to see what’s available.Verify:

The component/page/snippet exists in your Subframe project
The name or URL matches exactly
You have access to the project

Background job seems stuck

design_page, design_component, and edit_component run as background jobs. Check wait_for_jobs with the jobId returned by the design tool — it reports running, done, error, or not_found. The URL is live throughout, so opening it in the editor shows real-time progress.If a job stops reporting progress for ~10 minutes, the server treats it as stalled (worker died, request timed out) and reports it as error so polling never hangs — its summary explains that the result could not be verified. Open the URL to see whether anything was actually generated; the chat panel surfaces any errors from the AI agent.

Connection errors

If the MCP server is unreachable:

Check your internet connection
Verify the URL is https://mcp.subframe.com/mcp
Reach out to the Subframe team for support

Core concepts

Guides

Troubleshooting

Upgrading

Installation

Using the MCP server

Available tools

Discovery

Pages

Components

Snippets

Flows

Prototypes

Design documents

Theme

Design references

Async jobs

Prompt with MCP link

Example prompts

Troubleshooting

​Installation

​Using the MCP server

​Available tools

​Discovery

​Pages

​Components

​Snippets

​Flows

​Prototypes

​Design documents

​Theme

​Design references

​Async jobs

​Prompt with MCP link

​Example prompts

​Troubleshooting

Installation

Using the MCP server

Available tools

Discovery

Pages

Components

Snippets

Flows

Prototypes

Design documents

Theme

Design references

Async jobs

Prompt with MCP link

Example prompts

Troubleshooting