get-document-item
Retrieve information about a specific document item on a Miro board by providing board and item identifiers.
Instructions
Retrieve information about a specific document item on a Miro board
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| boardId | Yes | Unique identifier (ID) of the board that contains the document | |
| itemId | Yes | Unique identifier (ID) of the document that you want to retrieve |
Implementation Reference
- src/tools/getDocumentItem.ts:13-28 (handler)The handler function that validates inputs, calls the Miro API to retrieve the document item, and returns the data as JSON 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 documentData = await MiroClient.getApi().getDocumentItem(boardId, itemId); return ServerResponse.text(JSON.stringify(documentData, null, 2)); } catch (error) { return ServerResponse.error(error); } } - src/tools/getDocumentItem.ts:6-12 (schema)The ToolSchema definition including name, description, and Zod input schema for boardId and itemId.
const getDocumentItemTool: ToolSchema = { name: "get-document-item", description: "Retrieve information about a specific document item on a Miro board", args: { boardId: z.string().describe("Unique identifier (ID) of the board that contains the document"), itemId: z.string().describe("Unique identifier (ID) of the document that you want to retrieve") }, - src/index.ts:143-143 (registration)Registration of the getDocumentItemTool in the ToolBootstrapper chain.
.register(getDocumentItemTool) - src/index.ts:42-42 (registration)Import of the getDocumentItemTool for registration.
import getDocumentItemTool from './tools/getDocumentItem.js';