Miro

Miro is a collaborative online whiteboard enabling teams to brainstorm ideas, design wireframes, plan workflows, and manage projects visually miro · 81 tools · no triggers

Connect it

run auth miro
run auth miro --scope team    # shared with the organization

Or from the Integrations page in the console. See Connections for personal versus shared, and who may remove one.

Use it

run miro          # common commands
run miro --all    # every command

import { miro } from "@boxd/run";

Common tools

Tool	What it does
`attach-tag-to-item`	Tool to attach an existing tag to a specific item on a Miro board.
`create-board`	Tool to create a new board. Use when you need to set up a board with a specific name, description, and policies.
`create-card-item`	Tool to create a card item on a Miro board. Use when you need to add task cards with titles, descriptions, due dates, and assignees.
`create-connector`	Tool to create a connector (edge/arrow) that links two existing board items.
`create-document-item`	Tool to create a document item on a Miro board by providing a URL to the document.
`create-frame-item2`	DEPRECATED: Use MIRO_CREATE_FRAME_ITEM instead. Tool to create a frame on a Miro board.
`create-image-item-from-url`	Creates an image item on a Miro board by providing a URL to a publicly accessible image.
`create-image-item-using-local-file`	Tool to create an image item on a Miro board by uploading a local image file.
`create-items-in-bulk`	Tool to create multiple items on a Miro board in a single request.
`create-sticky-note-item`	Tool to create a sticky note item on a Miro board. Use when you need to add a new sticky note with customizable content, color, shape, and position.
`create-tag`	Tool to create a new tag on a Miro board. Use when you need to add a new tag with a specific title and color to categorize board items.
`create-text-item`	Tool to create a text item on a Miro board. Use when you need to add text content to a board, such as labels, notes, or annotations.
`delete-app-card-item`	Tool to delete an app card item from a board. Use when you need to remove an app card item created by your app after it is no longer needed.
`delete-frame-item`	Tool to delete a frame item from a Miro board. Use when you need to remove a frame that groups or organizes content on the board.
`delete-shape-item`	Tool to delete a shape item from a board. Use when you need to remove a specific shape that is no longer needed after confirming its board and item IDs.
`delete-text-item`	Tool to delete a text item from a board. Use when you need to remove a text item after confirming its board and item IDs.
`get-board`	DEPRECATED: Use MIRO_GET_SPECIFIC_BOARD instead. Tool to retrieve details of a specific board.
`get-board-members`	Tool to retrieve a list of members for a board. Use when you need to list all users with access to a board after confirming its ID.
`get-boards`	DEPRECATED: Use MIRO_MIRO_GET_BOARDS2 instead. Tool to retrieve accessible boards with optional filters.
`get-boards2`	Tool to retrieve accessible boards with optional filters. Use when you need to list or search boards by team, project, owner, or keywords with full pagination support.
`get-frame-item`	Tool to retrieve a specific frame item from a Miro board. Use when you need to fetch details of an existing frame by its ID.
`get-tag`	Tool to retrieve details of a specific tag on a board. Use when you have a board ID and tag ID and need its metadata.
`list-organizations`	Retrieves the organization associated with the current access token.
`remove-tag-from-item`	Tool to remove a tag from a specific item on a Miro board. Use when you need to disassociate a tag from an item after confirming the board, item, and tag IDs.
`update-embed-item`	Tool to update an embed item on a board. Use when you need to modify properties of an existing embedded content item such as position, display mode, or URL.

All 81 tools

Tool	What it does
`attach-tag-to-item`	Tool to attach an existing tag to a specific item on a Miro board.
`create-app-card-item`	Tool to add an app card item to a board. Use when you need to push a rich preview card with custom fields into a Miro board.
`create-board`	Tool to create a new board. Use when you need to set up a board with a specific name, description, and policies.
`create-card-item`	Tool to create a card item on a Miro board. Use when you need to add task cards with titles, descriptions, due dates, and assignees.
`create-connector`	Tool to create a connector (edge/arrow) that links two existing board items.
`create-document-item`	Tool to create a document item on a Miro board by providing a URL to the document.
`create-document-item-using-file-from-device`	Tool to create a document item on a Miro board using a URL to the document.
`create-embed-item`	Tool to create an embed item on a Miro board by providing a URL to embed content (YouTube videos, websites, etc.).
`create-frame-item`	Tool to add a frame item to a Miro board. Use frames to group and organize diagram regions (e.g., swimlanes, sections, slides).
`create-frame-item2`	DEPRECATED: Use MIRO_CREATE_FRAME_ITEM instead. Tool to create a frame on a Miro board.
`create-group`	Tool to create a group on a Miro board by grouping multiple items together.
`create-image-item-from-url`	Creates an image item on a Miro board by providing a URL to a publicly accessible image.
`create-image-item-using-local-file`	Tool to create an image item on a Miro board by uploading a local image file.
`create-items-in-bulk`	Tool to create multiple items on a Miro board in a single request.
`create-mindmap-node-experimental`	Tool to create a mind map node on a Miro board. Use when building mind maps or organizing ideas visually in a hierarchical structure.
`create-shape-item`	DEPRECATED: Use MIRO_MIRO_CREATE_SHAPE_ITEM2 instead. Tool to create a native Miro shape item (diagram node) on a board.
`create-shape-item2`	Tool to create a shape item on a Miro board. Use when you need to add shapes (basic or flowchart) to a board with specific styling and positioning.
`create-sticky-note-item`	Tool to create a sticky note item on a Miro board. Use when you need to add a new sticky note with customizable content, color, shape, and position.
`create-tag`	Tool to create a new tag on a Miro board. Use when you need to add a new tag with a specific title and color to categorize board items.
`create-text-item`	Tool to create a text item on a Miro board. Use when you need to add text content to a board, such as labels, notes, or annotations.
`delete-app-card-item`	Tool to delete an app card item from a board. Use when you need to remove an app card item created by your app after it is no longer needed.
`delete-card-item`	Tool to delete a card item from a board. Use when you need to remove a card item from a Miro board after it is no longer needed.
`delete-connector`	Tool to delete a specific connector from a board. Use when you need to remove a connector (edge/arrow) between board items after confirming its board and connector IDs.
`delete-document-item`	Tool to delete a document item from a board. Use when you need to remove a document item (e.g., PDF or image) that is no longer relevant.
`delete-embed-item`	Tool to delete an embed item from a board. Use when you need to remove an embedded content item (e.g., YouTube video, website) that is no longer needed.
`delete-frame-item`	Tool to delete a frame item from a Miro board. Use when you need to remove a frame that groups or organizes content on the board.
`delete-group`	Tool to delete a group from a board. Use when you need to remove a group and optionally its items.
`delete-image-item`	Tool to delete an image item from a board. Use when you need to remove an image that is no longer needed.
`delete-item`	Tool to delete a specific item from a board. Use when you need to remove an item (e.g., shape, sticky note) after confirming its board and item IDs.
`delete-mindmap-node-experimental`	Tool to delete a mind map node from a board. Use when you need to remove a mind map node after confirming its board and item IDs.
`delete-shape-item`	Tool to delete a shape item from a board. Use when you need to remove a specific shape that is no longer needed after confirming its board and item IDs.
`delete-sticky-note-item`	Tool to delete a sticky note item from a board. Use when you need to remove a sticky note that is no longer needed.
`delete-tag`	Tool to delete a specific tag from a board. Use when you need to remove a tag after confirming its board and tag IDs.
`delete-text-item`	Tool to delete a text item from a board. Use when you need to remove a text item after confirming its board and item IDs.
`get-all-groups`	Tool to retrieve all groups on a Miro board with cursor-based pagination.
`get-app-card-item2`	Tool to retrieve a specific app card item by its ID from a Miro board.
`get-board`	DEPRECATED: Use MIRO_GET_SPECIFIC_BOARD instead. Tool to retrieve details of a specific board.
`get-board-items`	Tool to list items on a Miro board (shapes, stickies, cards, etc.) with pagination.
`get-board-members`	Tool to retrieve a list of members for a board. Use when you need to list all users with access to a board after confirming its ID.
`get-boards`	DEPRECATED: Use MIRO_MIRO_GET_BOARDS2 instead. Tool to retrieve accessible boards with optional filters.
`get-boards2`	Tool to retrieve accessible boards with optional filters. Use when you need to list or search boards by team, project, owner, or keywords with full pagination support.
`get-card-item`	Tool to retrieve a specific card item from a Miro board. Use when you need to fetch details of an existing card item by its ID.
`get-connector`	Tool to retrieve a specific connector by its ID. Use when you need details about an existing connector on a board.
`get-connectors`	Tool to retrieve a list of connectors on a board. Use after confirming the board ID and when you need to page through connector items.
`get-document-item`	Tool to retrieve a specific document item from a Miro board by its ID.
`get-embed-item`	Tool to retrieve a specific embed item from a board by its ID.
`get-frame-item`	Tool to retrieve a specific frame item from a Miro board. Use when you need to fetch details of an existing frame by its ID.
`get-group-by-id`	Tool to retrieve a specific group by its ID. Use when you need to get details about a group on a Miro board.
`get-image-item`	Tool to retrieve a specific image item from a board. Use when you need to get details about an existing image item.
`get-items-by-group-id`	Tool to retrieve items of a specific group by its ID on a Miro board.
`get-items-within-frame`	Get items within a specific frame on a Miro board. Retrieves child items contained within a frame by filtering with parent_item_id parameter.
`get-item-tags`	Tool to retrieve tags attached to a specific item on a Miro board.
`get-mindmap-node-experimental`	Tool to retrieve a specific mind map node from a board. Use when you need to get details about a mind map node by its ID.
`get-mindmap-nodes-experimental`	Tool to retrieve mind map nodes from a Miro board. Use when you need to access the structure and content of mind maps on a board.
`get-oembed`	Tool to retrieve oEmbed data for a Miro board. Use when you need to generate embeddable HTML code for a board or get board metadata in oEmbed format.
`get-shape-item`	Tool to retrieve a specific shape item from a Miro board by its ID.
`get-specific-board`	Tool to retrieve detailed information about a specific board by its ID.
`get-specific-board-member`	Tool to retrieve details of a specific board member. Use when you have a board ID and board member ID and need to get that member’s role and information.
`get-specific-item`	Tool to retrieve a specific item from a Miro board by its ID.
`get-sticky-note-item`	Tool to retrieve a specific sticky note item from a board by its ID.
`get-tag`	Tool to retrieve details of a specific tag on a board. Use when you have a board ID and tag ID and need its metadata.
`get-text-item`	Tool to retrieve a specific text item from a Miro board by its ID.
`list-board-tags`	Tool to list all tags on a Miro board. Use when you need to discover tag IDs, titles, or colors before performing tag operations.
`list-organizations`	Retrieves the organization associated with the current access token.
`remove-tag-from-item`	Tool to remove a tag from a specific item on a Miro board. Use when you need to disassociate a tag from an item after confirming the board, item, and tag IDs.
`share-board`	Tool to share a board by inviting users via email. Use when you need to grant access to a board by sending email invitations to new members.
`update-app-card-item2`	Tool to update an app card item on a Miro board. Use when you need to modify properties of an existing app card such as title, description, status…
`update-board`	Tool to update properties of a specific board. Use when you have a board ID and need to modify its name, description, or permissions policy.
`update-board-member`	Tool to update the role of a specific board member. Use when you have a board ID and board member ID and need to change that member’s permissions or role on the board.
`update-card-item`	Tool to update a card item on a Miro board. Use when you need to modify properties of an existing card item such as title, description, due date…
`update-connector`	Tool to update an existing connector on a Miro board. Use when you need to modify connector properties such as shape, style, captions, or endpoint attachments.
`update-document-item`	Tool to update a document item on a Miro board. Use when you need to modify properties of an existing document item such as URL, title, position, or geometry.
`update-embed-item`	Tool to update an embed item on a board. Use when you need to modify properties of an existing embedded content item such as position, display mode, or URL.
`update-frame-item`	Tool to update a frame item on a Miro board. Use when you need to modify properties of an existing frame such as title, position, size, or styling.
`update-group`	Tool to update a group on a Miro board with new items. Use when you need to change which items belong to an existing group.
`update-image-item`	Tool to update an existing image item on a board. Use when you need to modify properties of an existing image item such as title, URL, position, or geometry.
`update-item-position-or-parent`	Tool to update an item’s position or parent frame on a Miro board.
`update-shape-item`	Tool to update an existing shape item on a Miro board. Use when you need to modify properties of a shape such as content, style, position, geometry, or parent.
`update-sticky-note-item`	Tool to update a sticky note item on a Miro board. Use when you need to modify the content, style, position, geometry, or parent of an existing sticky note.
`update-tag`	Tool to update a tag on a board. Use when you need to modify a tag’s title or color.
`update-text-item`	Tool to update a text item on a Miro board. Use when you need to modify the content, style, position, or other properties of an existing text item.

Open Miro in the console →

Getting started

Guides

Integrations & automations

Use cases

References

Connect it

Use it

Common tools

​Connect it

​Use it

​Common tools

Connect it

Use it

Common tools