Skip to main content

Tools and prompts

The Figma MCP server provides tools that let your agent read designs from Figma, write designs into Figma, connect designs to your codebase, and build generative plugins and shaders. This article describes each tool and includes example prompts you can use.

note

You don't need to name a tool in your prompt. Your agent chooses the right tools based on what you ask. For more reliable results, use Figma’s skills, which guide your agent through common workflows.

To get set up, see Get started with the Figma MCP server.

Index​

Tools marked Remote only aren't available on the desktop server.

Read tools​

ToolWhat it doesGroupRemote only
download_assetsDownloads exports and original source imagesDesign to code✓
get_code_connect_mapGets Code Connect mappings for selected instancesDesign systems and Code Connect
get_code_connect_suggestionsSuggests Code Connect mappings (Figma-prompted)Design systems and Code Connect
get_context_for_code_connectGets component metadata for Code Connect templates (Figma-prompted)Design systems and Code Connect✓
get_design_contextGets design context and code for a layer or selectionDesign to code
get_figjamConverts FigJam diagrams to XMLDesign to code
get_generative_pluginReads a generative plugin’s sourceGenerative plugins and shaders✓
get_librariesLists subscribed and available librariesDesign systems and Code Connect✓
get_metadataGets a lightweight XML outline of a selectionDesign to code
get_motion_contextGets keyframe animation data and code snippetsDesign to code
get_screenshotTakes a screenshot of a selectionDesign to code
get_shaderReads a shader’s sourceGenerative plugins and shaders
get_variable_defsLists variables and styles used in a selectionDesign to code
list_file_shadersLists shaders used in a specific fileGenerative plugins and shaders✓
list_generative_pluginsLists generative plugins in your libraryGenerative plugins and shaders✓
list_shadersLists shader effects and fills in your libraryGenerative plugins and shaders
search_design_systemSearches libraries for components, variables, and stylesDesign systems and Code Connect✓
whoamiGets your identity, plans, and seatsAccount✓

Write tools​

ToolWhat it doesGroupRemote only
add_code_connect_mapMaps a Figma component to a code componentDesign systems and Code Connect
create_generative_pluginCreates a generative plugin starterGenerative plugins and shaders✓
create_new_fileCreates a blank Figma Design, FigJam, or Figma Slides fileCode to design✓
create_shaderCreates a shader effect or fill starterGenerative plugins and shaders✓
generate_diagramGenerates a FigJam diagram from a description or Mermaid syntaxCode to design✓
generate_figma_designTurns live web UI into design layersCode to design✓
generate_imageGenerates and places an image in a Figma fileCode to design✓
html_to_figmaConverts an HTML document into design layersCode to design✓
send_code_to_figmaImports a local project into Figma as a Make file or code layerFigma Make and code layers✓
send_code_connect_mappingsConfirms suggested Code Connect mappings (Figma-prompted)Design systems and Code Connect
update_generative_pluginUpdates a generative plugin’s sourceGenerative plugins and shaders✓
update_shaderUpdates a shader’s sourceGenerative plugins and shaders✓
upload_assetsUploads images and SVGs into a Figma fileCode to design✓
use_figmaCreates, edits, and inspects content in Figma filesCode to design✓

(Figma-prompted) tools are used by Figma or by the figma-code-connect skill as part of a larger workflow. You don’t need to call them directly.

Weave tools are listed separately. The server also provides one MCP prompt, create_design_system_rules.

Design to code​

Use these tools to bring designs from Figma into your codebase. get_design_context is the main tool. The others provide extra input for it, or are useful when a selection is too large or you need assets in a specific format.

get_design_context​

Supported file types: Figma Design, Figma Make

Gets the design context for a layer or selection in Figma. By default, the output is React and Tailwind, but you can ask for a different framework in your prompt.

If your design uses shader fills or effects, the output includes a lightweight Figma shader runtime. This requires HTML-in-Canvas to display correctly.

Example prompts:

  • Change the framework

    • "Generate my Figma selection in Vue."
    • "Generate my Figma selection in plain HTML and CSS."
    • "Generate my Figma selection in iOS."
  • Use your components

    • "Generate my Figma selection using components from src/components/ui."
  • Combine both

    • "Generate my Figma selection using components from src/ui and style it with Tailwind."
  • Implement a design that uses shaders

    • "Implement this Figma frame in React using the included shader runtime."
tip

Set up Code Connect for the best component reuse. You can map more than one codebase to the same Figma components, such as React and SwiftUI.

  • The desktop server uses the Code Connect mapping you've selected in Dev Mode.
  • With the remote server, ask your agent to set the clientFrameworks parameter to your Code Connect label, such as React or SwiftUI.

On Professional plans, only one framework can be active at a time, so the MCP server returns connections for that framework only. Organization and Enterprise plans can have multiple active frameworks.

note

Prompting with your current selection only works with the desktop server. With the remote server, include a link to a frame or layer in your prompt.

get_metadata​

Supported file types: Figma Design

Returns a lightweight XML outline of your selection with basic properties only: layer IDs, names, types, positions, and sizes. Your agent can use this outline to call get_design_context on only the parts it needs. This is useful for very large designs, where get_design_context returns too much at once.

Without a node ID, get_metadata returns a list of the file's top-level pages. Your agent can use this list to choose a page to explore. If the node ID is invalid, the error response also includes the page list.

For more detail about each page, such as child counts and top-level node types, your agent can use use_figma to read the file structure directly.

get_screenshot​

Supported file types: Figma Design, FigJam, Figma Slides

Takes a screenshot of your selection so your agent can see the design. This helps the generated code match the layout more closely. Screenshots use more tokens, so leave this on unless you're concerned about token limits.

download_assets​

Supported file types: Figma Design, FigJam, Figma Slides

Downloads assets from a Figma file for up to 20 nodes per call. It returns temporary URLs your agent uses to fetch the files. Each call returns both:

  • Export renders: Each node rendered as PNG, JPG, SVG, or PDF. Uses the node's export settings in Figma if it has them. Otherwise, it uses the defaultFormat and defaultScale parameters (0.01x to 4x). Without export settings, renders at 1x are capped at about 4,096 px on the longest edge.
  • Raw source images: The original uploaded image files (JPEG, PNG, GIF, or WebP) used as fills anywhere inside the node, without re-rendering. Returns up to 20 images per call. If there are more, the response includes rawImagesTruncated: true; try a more specific child node.

When to use download_assets or get_screenshot

Use get_screenshot when your agent needs to see a design. Use download_assets when your agent needs to deliver an asset, export in a specific format, or move images between files.

get_screenshotdownload_assets
Use whenYou need to see a designYou need to save, deliver, or transfer an asset
Nodes per call1Up to 20
FormatsPNG onlyPNG, JPG, SVG, or PDF exports, plus original source images
OutputURL, or inline base64 with
enableBase64Response
URLs only
Original source filesNo, always re-rendersYes, returns the exact uploaded file

Example prompts:

  • Export assets in a specific format

    • "Export these icons from my Figma file as SVGs."
    • "Download the hero image from this frame as a JPG."
    • "Export this component as a PDF."
  • Get original source images

    • "Grab the original photos from this mockup."
    • "Extract the source images from this frame so I can move them to another file."
  • Move images between files

    • "Copy the images from this file into my other Figma file."

get_variable_defs​

Supported file types: Figma Design

Returns the variables and styles used in your selection, such as colors, spacing, and typography.

Example prompts:

  • List all variables used

    • "Get the variables used in my Figma selection."
  • Focus on a specific type

    • "What color and spacing variables are used in my Figma selection?"
  • Get names and values

    • "List the variable names and their values used in my Figma selection."

get_motion_context​

Supported file types: Figma Design

Returns animation data for an animated node so your agent can recreate the motion in code. The response includes:

  • A list of animated nodes
  • Keyframe tracks with easing curves
  • Ready-to-use CSS @keyframes and Motion code snippets
  • Hints about which nodes animate together

Use get_motion_context after get_design_context when a design includes animation, using the same node ID. get_design_context provides the static structure and styles, and get_motion_context adds the motion. To get motion data for every animated layer inside the selection in one call, set recursive: true.

get_figjam​

Supported file types: FigJam

Returns an XML outline of FigJam diagrams, similar to get_metadata, plus screenshots of the nodes.

Code to design​

Use these tools to write into Figma: create and edit files, layers, and content from code or from a description.

tip

These tools work best with a skill. Use figma-use for Figma Design, figma-use-figjam for FigJam, and figma-use-slides for Figma Slides.

use_figma​

Supported file types: Figma Design, FigJam, Figma Slides, Figma Specs

The general-purpose tool for writing to Figma files. Your agent can use it to create, edit, delete, or inspect content:

  • Figma Design: Pages, frames, components, variants, variables, styles, text, images, and more
  • FigJam: Stickies, sections, connectors, shapes, tables, code blocks, and more
  • Figma Slides: Slides, layouts, text, images, and other deck content
  • Figma Specs: Read, create, and edit specs, including specs embedded in Figma Design and FigJam files. Requires the figma-spec skill.

When relevant, your agent checks your design system and existing file content before creating anything from scratch.

note

use_figma can work with images that are already in your file, but it can't add new ones. To add new images, your agent uses upload_assets. To create a new image first, it can use generate_image.

note

Figma Specs is in open beta and is only available on plans where Specs is turned on.

Example prompts:

  • Create or update designs

    • "Add a new frame to my Figma file."
    • "Update the button component to use the correct fill color."
  • Set up variables or styles

    • "Create a color variable collection from my design tokens."
    • "Set up spacing variables in my Figma file."
  • Build or update components and variants

    • "Generate variants for the card component."
    • "Sync my Figma components with my latest code changes."
  • Fix layout or visual issues

    • "Fix the auto layout spacing on the nav component."
    • "Update the typography styles to match the design spec."
  • Create or update FigJam boards

    • "Organize this FigJam board into sections."
    • "Add stickies and connectors to summarize this project brief."
  • Read and update specs

    • "Read the spec in <Figma file URL> and implement the checkout requirements."
    • "Add the edge cases we found today to the open questions section of this spec."

generate_figma_design​

Supported file types: Figma Design

note

Available with select MCP clients. This tool doesn't count toward the standard Figma MCP server rate limits.

Sends the live UI of your web apps and sites to Figma as design layers. You can send it to:

  • A new Figma Design file
  • An existing Figma Design file
  • Your clipboard

New files are created in your team or organization drafts. To add to an existing file, you need edit access. Your seat type determines what you can create or edit.

For step-by-step instructions, see Code to canvas.

create_new_file​

Supported file types: No file needed

Creates a blank Figma Design, FigJam, or Figma Slides file in your drafts. If you belong to more than one plan, your agent asks which team or organization to use.

Example prompts:

  • "Create a new Figma file called 'Homepage Redesign.'"
  • "Create a new FigJam board for our project planning session."
  • "Create a new Figma Slides deck for our Q3 review."

upload_assets​

Supported file types: Figma Design, FigJam, Figma Slides

Uploads images and SVGs into a Figma file. Supports PNG, JPG, GIF, WebP, and SVG files up to 10 MB each, and up to 60 files per call.

  • Images: If you include a link to a specific layer, the image is added as that layer's fill. Otherwise, the tool creates new frames with the images as fills.
  • SVGs: Added as editable vector layers, not image fills.

To move images between Figma files, your agent uses download_assets to get the original images, then upload_assets to add them to the other file.

generate_diagram​

Supported file types: No file needed

Generates a FigJam diagram from a description or from Mermaid syntax. You don't need to write Mermaid yourself: describe the diagram you want and your agent generates the syntax. Diagrams can go in a new FigJam file or an existing one.

Supported diagram types: Flowcharts, Gantt charts, state diagrams, sequence diagrams, architecture diagrams, and entity relationship diagrams (ERDs)

Example prompts:

  • Generate a diagram from a description

    • "Create a flowchart for the user authentication flow using the Figma MCP generate_diagram tool."
    • "Generate a Gantt chart for the project timeline using the Figma MCP generate_diagram tool."
    • "Generate an ERD for a blog database with users, posts, and comments using the Figma MCP generate_diagram tool."
  • Convert existing Mermaid syntax

    • "Create a diagram from this Mermaid syntax: …"
tip

Your agent usually uses this tool automatically when you ask for a diagram. To make sure it does, include "using the Figma MCP generate_diagram tool" in your prompt.

html_to_figma​

Supported file types: Figma Design

Converts an HTML document into design layers in a Figma Design file. Use it for HTML from your codebase or HTML your agent creates, such as a visual style sheet based on your design tokens.

  • The result is plain layers. It doesn't use your components, libraries, or variables. To build with your design system, your agent uses use_figma instead.
  • It doesn't run your app or capture a live site. To capture a running web app, your agent uses generate_figma_design. To capture an external website, use the Figma Chrome extension.
  • The HTML must be self-contained, with CSS and images included in the document. External links aren't loaded. The document can be up to 50 MB.
  • Your agent can choose specific elements, like every card on a page, to turn each one into its own frame, up to 20 per call.

If you don't choose where to add the layers, they're added to a new page in the file.

Example prompts:

  • "Create a style sheet from our design tokens and add it to <Figma file URL>."
  • "Turn the cards in this HTML file into separate frames in <Figma file URL>."

generate_image​

Supported file types: Figma Design, FigJam, Figma Slides

Generates an image from a text description and places it in the file specified by fileKey. Omit nodeId to create a new image-filled frame, or provide it to replace an existing image fill without resizing the node. If you need a new file, call create_new_file first.

The tool checks AI permissions and credits against the destination file and returns its file key, the placed node ID, model, width, and height. Use download_assets to download the image.

  • Uses Figma AI credits. Each image uses AI credits from the destination file's plan, and the cost depends on the image model.
  • Size is approximate. The requested width and height set the aspect ratio, but the final size may be different.

Example prompts:

  • "Generate a hero image of a mountain trail at sunrise for our landing page."
  • "Create a product photo for this card and add it to <link to selection>."

Design systems and Code Connect​

Use these tools to find existing design system assets and to map Figma components to code components in your codebase.

get_libraries​

Supported file types: Figma Design

Lists the libraries for a Figma file in two groups: libraries already added to the file, and libraries you can add, such as Community UI kits and organization libraries. Each result includes the library's name, key, description, and source. Your agent uses this with search_design_system.

search_design_system​

Supported file types: Figma Design

Searches all connected libraries for components, variables, and styles that match a text query, so your agent can reuse what already exists instead of creating new elements. Your agent can send several searches in one call.

Example prompts:

  • Find components

    • "Search for a button component in my design system."
    • "Find a card component I can use for this layout."
  • Find variables

    • "Search for the primary color variable in my design system."
    • "Find spacing variables in my design libraries."
  • Narrow by type

    • "Search for icon styles in my design system."

get_code_connect_map​

Supported file types: Figma Design

Returns the Code Connect mappings for the instances in your selection. For each instance, the response includes:

  • componentName: The component's name in your codebase
  • source: Where the component lives in your codebase (file path or URL)
  • snippet, snippetImports, snippetNestedFunctions: Code snippet data, when available
  • version: Where the mapping came from, such as the Code Connect UI or CLI
  • label: The framework label, such as React, when available

Each selected instance appears separately, even if several use the same component. Nested components with their own mappings, such as an icon inside a button, may also be included.

With the remote server, your agent can use clientFrameworks and clientLanguages to choose which mappings are returned.

add_code_connect_map​

Supported file types: Figma Design

Maps a Figma component to its code component in your codebase. Mappings improve design-to-code output and help your agent use the exact components in your project.

Tools used by Figma​

Figma or the figma-code-connect skill uses these tools as part of a larger Code Connect workflow. You don't need to call them directly.

  • get_code_connect_suggestions: Detects Figma components and suggests which code components to map them to.
  • get_context_for_code_connect: Returns component details used to generate Code Connect templates, including properties, variant options, and nested instances and text layers.
  • send_code_connect_mappings: Confirms the mappings suggested by get_code_connect_suggestions.

All three support Figma Design files.

Generative plugins and shaders​

Use these tools to read and write the source code behind generative plugins, shader fills, and shader effects that you build by prompting Figma Agent.

ResourceListReadCreateUpdate
Generative pluginlist_generative_pluginsget_generative_plugincreate_generative_pluginupdate_generative_plugin
Shader (effect or fill)list_shaders
,
list_file_shaders
get_shadercreate_shaderupdate_shader
caution

Creating and updating requires a skill. Your agent must load figma-generative-plugins before creating or updating plugins, and figma-shaders before creating or updating shaders.

These rules apply to all tools in this group:

  • Access: You can read the code for any shader, but only for your own plugins. Every response includes an owner field: your email, figma, or a publisher handle.
  • Create returns a starter: create_generative_plugin and create_shader create a working starter, not a finished resource. Your agent follows up with the matching update tool.
  • Updates replace whole files: Updates must include the complete contents of each file, not just the changes. Files you don't include stay as they are. You can't add new files. Shaders have main.ts; plugins have code.ts and ui.html.
  • Plan keys come from whoami: Creating a plugin or shader requires a planKey, copied exactly from the plans whoami returns.
note

list_shaders and get_shader replace list_shader_effects, list_shader_fills, get_shader_effect, and get_shader_fill, which are deprecated.

list_generative_plugins​

Supported file types: No file needed

Lists the generative plugins in your account library, including Figma's own plugins. Generative plugins are runnable tools that change the canvas. They're separate from shader effects and fills.

Parameters: cursor (optional): The nextCursor value from a previous call, to get the next page. Leave it out to get the first page.

Response: Each plugin's id, name, description, and owner, plus nextCursor if there are more pages. owner is your email for plugins you own, or a public publisher handle.

Example prompts:

  • "List my generative plugins."
  • "Find my layer-renaming plugin so I can update it."

get_generative_plugin​

Supported file types: No file needed

Reads a generative plugin from your account library.

Parameters:

  • id: The plugin ID, from list_generative_plugins
  • version (optional): A 40-character commit SHA. Defaults to the latest built version.
  • includeSource (optional, default false): Includes each file's source in the response instead of a URI. Only for clients that can't read MCP resources. Limited to 100 files and 1,000,000 bytes total; the response says which limit was reached.

Response: The plugin's name, description, owner, version, and a list of its source files as { filename, bytes, uri }. By default, your agent reads each file from its uri as an MCP resource.

Example prompts:

  • "Show me the source for my layer-renaming plugin."
  • "Get version <commit SHA> of my layer-renaming plugin."

create_generative_plugin​

Supported file types: No file needed

Creates a new generative plugin in your account library. The plugin starts as a working starter that draws a square. Your agent then uses update_generative_plugin to add the behavior you want.

Requires the figma-generative-plugins skill.

Parameters:

  • name: The plugin's display name
  • description: A short description of what the plugin does
  • planKey: The plan that owns the plugin, in the format (team|organization)::<numeric-id>. Copied from whoami.

Response: The new plugin's ID, or an error message.

Example prompts:

  • "Create a new generative plugin called 'Layer renamer' in my team plan."
  • "Create a generative plugin, then update it to batch-rename my selected layers."

update_generative_plugin​

Supported file types: No file needed

Updates an existing generative plugin. Figma builds, versions, and deploys the update.

Requires the figma-generative-plugins skill.

Parameters:

  • id: The plugin ID
  • commitMessage (required): A Git commit message describing the change
  • files (optional, default []): A list of { path, content }. path must be code.ts or ui.html, and content must be the complete file. Your agent should read the current source with get_generative_plugin first.
  • metadata (optional): { name, description } to change the plugin's name or description. Send an empty files list to update only the metadata.

Response: The new version, or an error. A successful response may not include a version, so any response without an error means the update worked. If the build fails, the response includes compiler output; your agent should make the smallest fix it identifies and try once more.

code.ts runs in the plugin sandbox and is the only file that can call figma.*. ui.html is the plugin panel and the only file with DOM access; it uses PropsKit fig-* elements. You can't replace manifest.json.

list_shaders​

Supported file types: No file needed

Lists the shader effects and shader fills in your account library.

Parameters: cursor (optional): The nextCursor value from a previous call, to get the next page.

Response: Each shader's id, name, description, owner, and type, plus nextCursor if there are more pages. type is "effect" (changes the layer beneath it) or "fill" (generates its own pixels). owner is your email for shaders you own, or figma for Figma's shaders.

Example prompts:

  • "List the shaders in my library."
  • "Find my star field shader."

get_shader​

Supported file types: No file needed

Reads a shader effect or fill from your account library.

Parameters:

  • id: The shader ID, from list_shaders
  • version (optional): A 40-character commit SHA. Defaults to the latest built version.
  • includeSource (optional, default false): Includes each file's source in the response instead of a URI. Only for clients that can't read MCP resources. Limited to 100 files and 1,000,000 bytes total.

Response: The shader's name, description, owner, type, version, and a list of its source files as { filename, bytes, uri }.

Example prompts:

  • "Show me the source for my star field shader."
  • "Get version <commit SHA> of my star field shader."

create_shader​

Supported file types: No file needed

Creates a new shader effect or fill in your account library. Like create_generative_plugin, it creates a working starter. Your agent then uses update_shader to add the behavior you want.

Requires the figma-shaders skill.

Parameters:

  • name: The shader's display name
  • description: A one-line description of what it does
  • planKey: The plan that owns the shader, in the format (team|organization)::<numeric-id>. Copied from whoami.
  • kind: "effect" to change the layer beneath it, or "fill" to generate its own pixels

Response: The new shader's ID, or an error message.

Example prompts:

  • "Create a shader fill called 'Topographic contours' in my team plan."
  • "Create a shader effect called 'Chromatic blur' in my organization plan."

update_shader​

Supported file types: No file needed

Updates an existing shader effect or fill. Figma builds, versions, and deploys the update.

Requires the figma-shaders skill.

Parameters:

  • id: The shader ID
  • kind: "effect" or "fill". Must match the existing shader; you can't change the kind.
  • commitMessage (required): A Git commit message describing the change
  • files (optional, default []): A list of { path, content }. path must be main.ts, and content must be the complete file. Send an empty list to update only the metadata.
  • metadata (optional): { name, description } to change the shader's name or description

Response: The new version, or an error. A successful response may not include a version, so any response without an error means the update worked. If the build fails, the response includes compiler output; your agent should make the smallest fix it identifies and try once more.

list_file_shaders​

Supported file types: Figma Design

Lists the shader effects and fills used in a specific Figma file. Use this to read a shader you don't own: you only need view access to the file. Source code is returned for the exact shader version the file uses, so what you read matches what the file shows.

Parameters: fileKey: The key of the Figma file

Response: Up to 100 shaders. For each shader:

  • id: The shader ID
  • name: Display name
  • description: Short description
  • type: "effect" or "fill"
  • version: The exact version the file uses
  • published: Whether this is a published library version
  • truncated: true if the shader's file list reached its 10,000-file limit
  • files: The shader's source files as { filename, uri }

A top-level truncated: true means at least one shader couldn't be returned, including when the file uses more than 100 shaders.

Example prompts:

  • "What shaders are used in this Figma file?"
  • "Show me the source for the background shader in this file."

Figma Make and code layers​

Use these tools to bring code projects into Figma and keep building them with the Figma Make agent. Your agent can create a Figma Make file or a code layer in a Figma Design file, send prompts, and check progress.

tip

Mention “code layer” in your prompt when you want your agent to bring a project into a Figma Design file.

send_code_to_figma​

Supported file types: Figma Make, Figma Design

Imports a project from your computer into Figma. In a Figma Make file, the project becomes the file's code. In a Figma Design file, it becomes a new code layer. It doesn't create design layers.

  • Requires edit access to the file.
  • Your agent packages the project as a .zip, .tar.gz, or .tgz file and uploads it.
  • The first import doesn't use Figma AI credits. Prompting and later changes do.

After importing, open the file to preview the project.

Example prompts:

  • "Import this project into <Figma file URL> as a code layer."
  • "Bring the checkout flow from this repo into a new Figma Make file."
note

Importing a project with send_code_to_figma doesn't use credits, but prompting and later changes do.

Account​

whoami​

Supported file types: No file needed

Returns details about the Figma account you're signed in with:

  • Your email address
  • All the plans you belong to
  • Your seat type on each plan

Your agent needs this to create generative plugins and shaders, which require a planKey from the plans list.

Figma Weave​

Use these tools to run Figma Weave from your agent. Your agent can run a published Weave tool, or run a Weave model directly without publishing a tool first. In Weave, a “tool” is a published Weave workflow, not an MCP tool.

note

You need a paid standalone Figma Weave account to run Weave tools. Runs use your Weave credits, not your Figma AI credits. Before a paid run, your agent shows you the cost and asks you to confirm.

weave_list_tools​

Supported file types: No file needed

Lists the Weave tools you can run in your active Weave workspace: your own tools, tools shared with the workspace, and tools shared with you by email. Private tools aren't included.

Parameters: search (optional): Text to match against tool names, not case-sensitive.

Response: The most recently updated tools and the total number available. For each tool: its name, creator, last updated date, and a link to open it in Weave.

Example prompts:

  • "Show me the Weave tools I can run."
  • "Find the 'image generator' Weave tool."
tip

If you already have a Weave link (app.weavy.ai/tool/<id> or app.weavy.ai/flow/<id>), the <id> is the tool's recipeId. Your agent can skip this step and go straight to weave_get_tool_inputs.

weave_get_tool_inputs​

Supported file types: No file needed

Gets the inputs a Weave tool needs to run. Your agent uses this before weave_run_tool.

Parameters:

  • recipeId: The Weave tool ID, from weave_list_tools
  • version (optional): The tool version. Defaults to the latest.

Response: The tool version, a summary of its outputs, and a list of inputs with each input's nodeId, name, type, required, description, options, range, isIterator, and default.

Example prompts:

  • "What inputs does the 'image generator' Weave tool take?"
  • "Show me the inputs and their defaults for this Weave tool."

weave_upload_asset​

Supported file types: Images (PNG, JPG, WebP, HEIC), video (MP4, MOV, WebM), audio (MP3, WAV, OGG, and other common formats), and 3D models (GLB, OBJ, FBX, PLY)

Uploads an attached file so it can be used as an input for weave_run_tool. Files that already have a public HTTPS URL don't need to be uploaded.

Parameters: recipeId: The Weave tool the file is for

Response: A single-use submitUrl for the upload. After the upload, the file's permanent hosted URL.

Example prompts:

  • "Use this image as the reference input for the Weave tool."
  • "Upload this file to Weave so I can run a tool on it."

weave_run_tool​

Supported file types: No file needed

Runs a Weave tool. Your agent uses weave_get_tool_inputs first, then checks progress with weave_get_tool_run_output.

Because runs use credits, the tool won't start until it has what it needs. If inputs are missing or invalid, it returns inputs_required. If the run has a cost, it returns cost_confirmation_required with the number of credits. Your agent confirms with you before running.

Parameters:

  • recipeId: The Weave tool ID
  • version (optional): The tool version
  • inputs (optional): A list of { nodeId, value }
  • numberOfRuns (optional): 1 to 10
  • acknowledgedCost (optional): Set after you confirm the cost

Response: The runIds of the runs that started, or a status explaining what's needed.

Example prompts:

  • "Run the 'image generator' Weave tool with the prompt 'a cat.'"
  • "Run this Weave tool 3 times."

weave_get_tool_run_output​

Supported file types: No file needed

Gets the status and output of Weave runs.

Parameters: recipeId, and optionally runIds

Response: For each run: its status (RUNNING, COMPLETED, FAILED, or CANCELED), progress, any errors, and the output once it's complete.

Example prompts:

  • "Is my Weave run done yet?"
  • "Show me the output of my last Weave run."

weave_cancel_tool_run​

Supported file types: No file needed

Cancels one or more in-progress runs. You can't undo this.

Parameters: recipeId, and optionally runIds. Leave out runIds to cancel all runs.

Response: Confirmation of the canceled runs.

Example prompts:

  • "Cancel that Weave run."
  • "Cancel all my running Weave tool runs."

weave_find_model​

Supported file types: No file needed

Finds a Weave model by name so your agent can run it with weave_run_model. Use this when you name a model in your prompt. If the name matches more than one model, your agent shows you the options.

Parameters: query: The model name, as you said it

Response: The model, its approximate cost, and the inputs and settings it accepts, including which are required and any allowed values. If more than one model matches, a short list of options.

Example prompts:

  • "Run Nano Banana 2 on this image."
  • "Make a video of this product photo with Veo 3."

weave_run_model​

Supported file types: No file needed

Runs a Weave model directly, without a published Weave tool. Your agent uses weave_find_model first, then checks progress with weave_get_model_run_output.

Because runs use Weave credits, your agent shows you the cost and asks you to approve every run, including reruns. If an input is missing, your agent asks you for it.

Parameters:

  • id: The model ID, from weave_find_model
  • input: The inputs and settings to run with. For images, video, or other media, your agent uses a file uploaded with weave_upload_asset, an earlier run's output, or a public HTTPS link.
  • acknowledgedCost (optional): Set after you approve the cost

Response: A prediction ID to check progress, or the cost to approve before the run starts.

weave_get_model_run_output​

Supported file types: No file needed

Gets the status and output of model runs started with weave_run_model. For runs of published Weave tools, your agent uses weave_get_tool_run_output instead.

Parameters: predictionIds: The prediction IDs returned by weave_run_model

Response: The status and output of each run, with links to download the results.

Example prompts:

  • "Is my video done yet?"
  • "Download the images from my last model run."

MCP prompts​

MCP prompts are different from the prompts you type to chat with your agent. They're built into the MCP server, and you run them with a command in your client. The command depends on the client, and not all clients support MCP prompts. Check your client's documentation.

create_design_system_rules​

Supported file types: No file needed

Creates a rules file that gives your agent the context it needs to turn designs into code that fits your codebase, design system, and tech stack.

After running the prompt, save the result to your project's rules/ or instructions/ folder so your agent can use it when generating code.