get-all-groups
Use this tool to retrieve all groups from a specific Miro board by providing the board ID. Supports pagination with limit and cursor parameters for efficient data management.
Instructions
Retrieve all groups on a Miro board
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| boardId | Yes | ID of the board whose groups you want to retrieve | |
| cursor | No | Cursor for pagination | |
| limit | No | Maximum number of groups to return (default: 50) |
Implementation Reference
- src/tools/getAllGroups.ts:14-31 (handler)The tool handler function that fetches all groups from the specified Miro board, supporting pagination with limit and cursor parameters, and returns the result as formatted JSON or an error response.fn: async ({ boardId, limit, cursor }) => { try { if (!boardId) { return ServerResponse.error("Board ID is required"); } const options: any = {}; if (limit) options.limit = limit; if (cursor) options.cursor = cursor; const result = await MiroClient.getApi().getAllGroups(boardId, options); return ServerResponse.text(JSON.stringify(result, null, 2)); } catch (error) { process.stderr.write(`Error retrieving groups: ${error}\n`); return ServerResponse.error(error); } }
- src/tools/getAllGroups.ts:9-13 (schema)Input schema definition using Zod for the get-all-groups tool parameters: boardId (required string), limit (optional number), cursor (optional string).args: { boardId: z.string().describe("ID of the board whose groups you want to retrieve"), limit: z.number().optional().nullish().describe("Maximum number of groups to return (default: 50)"), cursor: z.string().optional().nullish().describe("Cursor for pagination") },
- src/index.ts:179-179 (registration)Registration of the getAllGroupsTool with the ToolBootstrapper instance in the main server bootstrap process..register(getAllGroupsTool)
- src/index.ts:78-78 (registration)Import statement for the getAllGroupsTool module used in registration.import getAllGroupsTool from './tools/getAllGroups.js';