get-items-on-board
Retrieve and organize all items from a specific Miro board by providing the board ID. Supports pagination with customizable limit and offset parameters.
Instructions
Retrieve all items on a specific Miro board
Input 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) |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"boardId": {
"description": "Unique identifier (ID) of the board whose items you want to retrieve",
"type": "string"
},
"limit": {
"description": "Maximum number of items to return (default: 50)",
"type": "number"
},
"offset": {
"description": "Offset for pagination (default: 0)",
"type": "number"
}
},
"required": [
"boardId"
],
"type": "object"
}
Implementation Reference
- src/tools/getItemsOnBoard.ts:14-28 (handler)The handler function that implements the core logic of the 'get-items-on-board' tool. It validates the boardId, fetches items from the Miro board using MiroClient with optional limit (offset not used in API call), formats the response as JSON, or returns an 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)Input schema defined using Zod for validating tool arguments: 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:116-118 (registration)Registration of the tool with the ToolBootstrapper instance in the main index file, following the import from './tools/getItemsOnBoard.js'..register(getSpecificBoardTool) .register(getItemsOnBoardTool) .register(getSpecificItemTool)