list-boards
Retrieve a list of all available Miro boards with options to limit results and paginate for easier management and organization.
Instructions
List all available Miro boards
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of boards 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": {
"limit": {
"description": "Maximum number of boards to return (default: 50)",
"type": "number"
},
"offset": {
"description": "Offset for pagination (default: 0)",
"type": "number"
}
},
"type": "object"
}
Implementation Reference
- src/tools/listBoards.ts:13-24 (handler)The handler function for the 'list-boards' tool that fetches Miro boards using the API and returns formatted JSON or handles errors.fn: async ({ limit = 50, offset = 0 }) => { try { const boardsData = await MiroClient.getApi().getBoards(); return ServerResponse.text(JSON.stringify(boardsData, null, 2)) } catch (error) { process.stderr.write(`Error fetching Miro boards: ${error}\n`); return ServerResponse.error(error) } }
- src/tools/listBoards.ts:6-12 (schema)ToolSchema definition with name, description, and Zod input schema for 'limit' and 'offset' parameters.const listBoardsTool: ToolSchema = { name: "list-boards", description: "List all available Miro boards", args: { limit: z.number().optional().nullish().describe("Maximum number of boards to return (default: 50)"), offset: z.number().optional().nullish().describe("Offset for pagination (default: 0)") },
- src/index.ts:111-111 (registration)Registration of the list-boards tool using ToolBootstrapper.register() in the main index file..register(listBoardsTool)