get-frame-item
Retrieve specific frame details from a Miro board by providing the board and frame IDs to streamline collaboration and data extraction.
Instructions
Retrieve information for a specific frame on a Miro board
Input 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 |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"boardId": {
"description": "Unique identifier (ID) of the board that contains the frame that you want to retrieve",
"type": "string"
},
"itemId": {
"description": "Unique identifier (ID) of the frame that you want to retrieve",
"type": "string"
}
},
"required": [
"boardId",
"itemId"
],
"type": "object"
}
Implementation Reference
- src/tools/getFrameItem.ts:13-31 (handler)The handler function that executes the core logic of the 'get-frame-item' tool. It performs input validation, retrieves the frame item from the Miro API using MiroClient.getApi().getFrameItem(boardId, itemId), formats the response as JSON, and handles errors.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:6-12 (schema)The ToolSchema definition including name, description, and Zod input schema (args) for validating boardId and itemId parameters.const getFrameItemTool: ToolSchema = { name: "get-frame-item", description: "Retrieve information for a specific frame on a Miro board", 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 getFrameItemTool with the ToolBootstrapper instance, making the tool available in the MCP server..register(getFrameItemTool)