get-frame-item
Retrieve specific frame details from a Miro board using board and item IDs to access structured content information.
Instructions
Retrieve information for a specific frame on a Miro board
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| boardId | Yes | Unique identifier (ID) of the board that contains the frame that you want to retrieve | |
| itemId | Yes | Unique identifier (ID) of the frame that you want to retrieve |
Implementation Reference
- src/tools/getFrameItem.ts:13-31 (handler)The handler function that implements the core logic of the 'get-frame-item' tool. It validates inputs, calls the Miro API to retrieve the frame item, and returns the result as formatted JSON or an error.
fn: async ({ boardId, itemId }: { boardId: string, itemId: string }) => { try { if (!boardId) { return ServerResponse.error("Board ID is required"); } if (!itemId) { return ServerResponse.error("Item ID is required"); } const result = await MiroClient.getApi().getFrameItem(boardId, itemId); return ServerResponse.text(JSON.stringify(result, null, 2)); } catch (error) { return ServerResponse.error(error); } } - src/tools/getFrameItem.ts:9-12 (schema)Zod-based input schema defining the required parameters 'boardId' and 'itemId' for the tool.
args: { boardId: z.string().describe("Unique identifier (ID) of the board that contains the frame that you want to retrieve"), itemId: z.string().describe("Unique identifier (ID) of the frame that you want to retrieve") }, - src/index.ts:139-139 (registration)Registration of the 'get-frame-item' tool using the ToolBootstrapper's register method.
.register(getFrameItemTool)