list-boards
Retrieve all available Miro boards with pagination controls to manage large collections efficiently.
Instructions
List all available Miro boards
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "list-boards"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of boards to return (default: 50) | |
| offset | No | Offset for pagination (default: 0) |
Implementation Reference
- src/tools/listBoards.ts:13-24 (handler)The asynchronous handler function that executes the 'list-boards' tool logic. It fetches all available Miro boards using MiroClient.getApi().getBoards(), handles pagination parameters (limit and offset), and returns the boards data as JSON or an error response.
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)The ToolSchema definition for 'list-boards', including the tool name, description, and Zod-based input schema for optional 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)The registration of the 'list-boards' tool into the ToolBootstrapper instance, which adds it to the MCP server tools list.
.register(listBoardsTool)