create-frame
Add a new frame to organize content on a Miro board by specifying its position, dimensions, title, and style.
Instructions
Create a new frame on a Miro board
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| boardId | Yes | Unique identifier (ID) of the board where the frame will be created | |
| data | Yes | The content and configuration of the frame | |
| position | Yes | Position of the frame on the board | |
| geometry | No | Dimensions of the frame | |
| style | No | Style configuration of the frame |
Implementation Reference
- src/tools/createFrameItem.ts:32-82 (handler)The asynchronous handler function that implements the 'create-frame' tool. It validates the boardId, constructs a FrameCreateRequest using the provided data, position, geometry, and style, then calls MiroClient.getApi().createFrameItem to create the frame on the board and returns the result.fn: async ({ boardId, data, position, geometry, style }: { boardId: string, data: { title?: string, format?: string, type?: string, showContent?: boolean }, position: { x: number, y: number }, geometry?: { width?: number, height?: number }, style?: { fillColor?: string } }) => { try { if (!boardId) { return ServerResponse.error("Board ID is required"); } const createRequest = new FrameCreateRequest(); const frameData = new FrameChanges(); if (data.title !== undefined) frameData.title = data.title; if (data.format !== undefined) frameData.format = data.format; if (data.type !== undefined) frameData.type = data.type; if (data.showContent !== undefined) frameData.showContent = data.showContent; createRequest.data = frameData; createRequest.position = position; if (geometry) { createRequest.geometry = geometry; } if (style) { createRequest.style = style; } const result = await MiroClient.getApi().createFrameItem(boardId, createRequest); return ServerResponse.text(JSON.stringify(result, null, 2)); } catch (error) { return ServerResponse.error(error); } }
- src/tools/createFrameItem.ts:10-31 (schema)The Zod-based input schema defining the parameters for the 'create-frame' tool: boardId, data (title, format, type, showContent), position (x, y), optional geometry (width, height), and optional style (fillColor).name: "create-frame", description: "Create a new frame on a Miro board", args: { boardId: z.string().describe("Unique identifier (ID) of the board where the frame will be created"), data: z.object({ title: z.string().optional().nullish().describe("Title of the frame. This title appears at the top of the frame."), format: z.string().optional().nullish().describe("Format of the frame. Only 'custom' is supported currently."), type: z.string().optional().nullish().describe("Type of the frame. Only 'freeform' is supported currently."), showContent: z.boolean().optional().nullish().describe("Hide or reveal the content inside a frame (Enterprise plan only).") }).describe("The content and configuration of the frame"), position: z.object({ x: z.number().describe("X coordinate of the frame"), y: z.number().describe("Y coordinate of the frame") }).describe("Position of the frame on the board"), geometry: z.object({ width: z.number().optional().nullish().describe("Width of the frame"), height: z.number().optional().nullish().describe("Height of the frame") }).optional().nullish().describe("Dimensions of the frame"), style: z.object({ fillColor: z.string().optional().nullish().describe("Fill color for the frame. Hex values like #f5f6f8, #d5f692, etc.") }).optional().nullish().describe("Style configuration of the frame") },
- src/index.ts:138-138 (registration)Registers the 'create-frame' tool (imported as createFrameItemTool) with the ToolBootstrapper instance..register(createFrameItemTool)