get-items-on-board
Retrieve all items from a specific Miro board using its unique identifier, with options for pagination and limiting results.
Instructions
Retrieve all items on a specific Miro board
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| boardId | Yes | Unique identifier (ID) of the board whose items you want to retrieve | |
| limit | No | Maximum number of items to return (default: 50) | |
| offset | No | Offset for pagination (default: 0) |
Implementation Reference
- src/tools/getItemsOnBoard.ts:14-28 (handler)The main handler function for the 'get-items-on-board' tool. It fetches items from a Miro board using the MiroClient API, handles pagination with limit (offset not used), and returns JSON data or error.
fn: async ({ boardId, limit = 50, offset = 0 }) => { try { if (!boardId) { return ServerResponse.error("Board ID is required"); } const itemsData = await MiroClient.getApi().getItems(boardId, { limit: limit.toString(), }); return ServerResponse.text(JSON.stringify(itemsData, null, 2)); } catch (error) { return ServerResponse.error(error); } } - src/tools/getItemsOnBoard.ts:9-13 (schema)Zod schema defining the input parameters for the tool: boardId (required string), limit and offset (optional numbers).
args: { boardId: z.string().describe("Unique identifier (ID) of the board whose items you want to retrieve"), limit: z.number().optional().nullish().describe("Maximum number of items to return (default: 50)"), offset: z.number().optional().nullish().describe("Offset for pagination (default: 0)") }, - src/index.ts:117-117 (registration)Registers the get-items-on-board tool with the ToolBootstrapper in the main server index file.
.register(getItemsOnBoardTool)