get-document-item
Retrieve details of a specific document item on a Miro board by providing the board ID and document ID. Simplify accessing and managing document information within Miro's collaborative environment.
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 executes the tool logic: validates boardId and itemId, fetches the document item from Miro API, and returns the JSON response or error.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:9-12 (schema)Zod schema defining the input parameters: boardId and itemId as strings with descriptions.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)Registers the getDocumentItemTool with the MCP server via ToolBootstrapper chain..register(getDocumentItemTool)