Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.subframe.com/llms.txt

Use this file to discover all available pages before exploring further.

Our MCP server lets AI coding assistants like Claude Code, Cursor, and Codex access your Subframe designs directly. Instead of copying code manually, AI can fetch components, pages, and themes from your projects automatically. We also have a separate Subframe Docs MCP server that provides access to Subframe documentation (this site).

Installation

1

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.
2

Enable auto-update (recommended)

Keep the Subframe plugin up to date automatically:
  1. Run /plugin to open the plugin manager
  2. Select the Marketplaces tab
  3. Choose the subframe marketplace
  4. Select Enable auto-update
3

Verify installation

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

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
Copy MCP link from Subframe

Available tools

ToolDescriptionInput ParametersReturns
list_projectsLists all projects you have access toArray of projects with projectId, name, teamId, teamName
generate_auth_tokenGenerates a CLI auth token for a teamteamIdauthToken
get_project_infoGets project info including design documentationprojectIdid, name, docs (array of title, contents)
list_componentsLists all components in your projectprojectIdArray of components with id, name, url
list_pagesLists all pages in your projectprojectIdArray of pages with id, name, url
get_component_infoGets the code and metadata for a componentid, name, or url
projectId
id, name, files
get_page_infoGets the code for a pageid, name, or url
projectId
id, name, files
get_flow_infoGets a flow with its name and ordered list of pages. A flow groups related pages together (e.g. an onboarding flow).id, name, or url
projectId
id, name, pages (array of id, name)
get_themeGenerates the Tailwind theme for the projectprojectId
cssType (optional)
theme config
edit_themeEdits the visual theme of a project (colors, fonts, corners, shadows) from a natural-language prompt. Best for targeted tweaks or high-level shifts. Optionally pass a page to preview the change before applying.description
id, name, or url (optional, page to preview)
projectId
editUrl
design_pageDesigns UI pages in Subframe. Use to build new UI, iterate on existing UI, explore options, or get a visual starting point to refine. Each requested variation lands as a page in a single Subframe flow as it finishes generating.description, variations (1, 2, or 4 objects with name and description), flowName
projectId, codeContext (optional), additionalPages (optional)
flowId, flowUrl
edit_pageEdits an existing Subframe page. Use for targeted changes to an existing page. Describe the changes you want, optionally including code snippets for precision. The edit is applied immediately.id, name, or url
description
projectId
pageUrl
design_page returns flowId for working with the destination flow (long-lived, shared by multiple design_page calls with the same flowName) and flowUrl for opening the flow editor. Read the variation pages via get_flow_info once they’ve finished generating. 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

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 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.
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 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.
Get the Button component from Subframe and use it in this file
Show me all components in my Subframe project
Get my Subframe theme configuration

Troubleshooting

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
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.
Use list_components or list_pages to see what’s available.Verify:
  • The component/page exists in your Subframe project
  • The name or URL matches exactly
  • You have access to the project
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
Last modified on May 11, 2026