delete-group
Remove a specific group from a Miro board, with options to delete or preserve the items within the group.
Instructions
Delete a specific group from a Miro board
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| boardId | Yes | ID of the board that contains the group | |
| groupId | Yes | ID of the group that you want to delete | |
| deleteItems | No | Indicates whether the items should be removed. Set to true to delete items in the group, false to keep them |
Implementation Reference
- src/tools/deleteGroup.ts:14-31 (handler)The asynchronous handler function that implements the logic for the 'delete-group' tool. It validates inputs, calls the Miro API to delete the group, and returns a success or error response.
fn: async ({ boardId, groupId, deleteItems }) => { try { if (!boardId) { return ServerResponse.error("Board ID is required"); } if (!groupId) { return ServerResponse.error("Group ID is required"); } await MiroClient.getApi().deleteGroup(boardId, groupId, deleteItems ?? false); return ServerResponse.text(JSON.stringify({ success: true, message: "Group successfully deleted" }, null, 2)); } catch (error) { process.stderr.write(`Error deleting group: ${error}\n`); return ServerResponse.error(error); } } - src/tools/deleteGroup.ts:7-13 (schema)The schema definition for the 'delete-group' tool, including name, description, and Zod input schema for parameters boardId, groupId, and optional deleteItems.
name: "delete-group", description: "Delete a specific group from a Miro board", args: { boardId: z.string().describe("ID of the board that contains the group"), groupId: z.string().describe("ID of the group that you want to delete"), deleteItems: z.boolean().optional().nullish().describe("Indicates whether the items should be removed. Set to true to delete items in the group, false to keep them") }, - src/index.ts:184-184 (registration)The registration of the deleteGroupTool in the ToolBootstrapper chain in the main index file.
.register(deleteGroupTool)