get-shape-item
Retrieve information about a specific shape on a Miro board by providing the board and shape IDs.
Instructions
Retrieve information about a specific shape item on a Miro board
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"boardId": "<boardId>",
"itemId": "<itemId>"
},
"name": "get-shape-item"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| boardId | Yes | Unique identifier (ID) of the board that contains the shape | |
| itemId | Yes | Unique identifier (ID) of the shape that you want to retrieve |
Implementation Reference
- src/tools/getShapeItem.ts:13-28 (handler)The handler function for the 'get-shape-item' tool. It validates boardId and itemId, calls MiroClient.getApi().getShapeItem, and returns the JSON result or an error response.
fn: async ({ boardId, itemId }) => { try { if (!boardId) { return ServerResponse.error("Board ID is required"); } if (!itemId) { return ServerResponse.error("Item ID is required"); } const result = await MiroClient.getApi().getShapeItem(boardId, itemId); return ServerResponse.text(JSON.stringify(result, null, 2)); } catch (error) { return ServerResponse.error(error); } } - src/tools/getShapeItem.ts:6-12 (schema)Tool schema definition including name, description, and Zod input schema for boardId and itemId parameters.
const getShapeItemTool: ToolSchema = { name: "get-shape-item", description: "Retrieve information about a specific shape item on a Miro board", args: { boardId: z.string().describe("Unique identifier (ID) of the board that contains the shape"), itemId: z.string().describe("Unique identifier (ID) of the shape that you want to retrieve") }, - src/index.ts:158-158 (registration)Registration of the getShapeItemTool with the ToolBootstrapper instance.
.register(getShapeItemTool)