get-group-items
Retrieve all items within a specific group on a Miro board by providing the board and group IDs. Supports pagination with limit and cursor parameters for efficient data handling.
Instructions
Retrieve all items in a specific group on a Miro board
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| boardId | Yes | ID of the board that contains the group | |
| cursor | No | Cursor for pagination | |
| groupId | Yes | ID of the group whose items you want to retrieve | |
| limit | No | Maximum number of items to return (default: 50) |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"boardId": {
"description": "ID of the board that contains the group",
"type": "string"
},
"cursor": {
"description": "Cursor for pagination",
"type": "string"
},
"groupId": {
"description": "ID of the group whose items you want to retrieve",
"type": "string"
},
"limit": {
"description": "Maximum number of items to return (default: 50)",
"type": "number"
}
},
"required": [
"boardId",
"groupId"
],
"type": "object"
}
Implementation Reference
- src/tools/getGroupItems.ts:15-36 (handler)Handler function implementing the logic to retrieve items within a group on a Miro board using the MiroClient API, with input validation, pagination support, and error handling.fn: async ({ boardId, groupId, limit, cursor }) => { try { if (!boardId) { return ServerResponse.error("Board ID is required"); } if (!groupId) { return ServerResponse.error("Group ID is required"); } const options: any = {}; if (limit) options.limit = limit; if (cursor) options.cursor = cursor; const result = await MiroClient.getApi().getItemsByGroupId(boardId, groupId, options); return ServerResponse.text(JSON.stringify(result, null, 2)); } catch (error) { process.stderr.write(`Error retrieving group items: ${error}\n`); return ServerResponse.error(error); } }
- src/tools/getGroupItems.ts:6-14 (schema)ToolSchema definition including name, description, and Zod input schema for parameters: boardId (required), groupId (required), limit (optional), cursor (optional).const getGroupItemsTool: ToolSchema = { name: "get-group-items", description: "Retrieve all items in a specific group on a Miro board", args: { boardId: z.string().describe("ID of the board that contains the group"), groupId: z.string().describe("ID of the group whose items you want to retrieve"), limit: z.number().optional().nullish().describe("Maximum number of items to return (default: 50)"), cursor: z.string().optional().nullish().describe("Cursor for pagination") },
- src/index.ts:181-181 (registration)Registers the getGroupItemsTool with the ToolBootstrapper instance..register(getGroupItemsTool)
- src/index.ts:80-80 (registration)Imports the getGroupItemsTool for registration.import getGroupItemsTool from './tools/getGroupItems.js';