get-group
Retrieve details about a specific group on a Miro board by providing the board ID and group ID. Access the necessary information for efficient board management.
Instructions
Retrieve information about a specific group on a Miro board
Input 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 retrieve |
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"
},
"groupId": {
"description": "ID of the group that you want to retrieve",
"type": "string"
}
},
"required": [
"boardId",
"groupId"
],
"type": "object"
}
Implementation Reference
- src/tools/getGroup.ts:13-30 (handler)The asynchronous handler function that executes the "get-group" tool logic. It validates inputs, calls MiroClient.getApi().getGroupById(boardId, groupId), and returns the result as JSON or an error.fn: async ({ boardId, groupId }) => { try { if (!boardId) { return ServerResponse.error("Board ID is required"); } if (!groupId) { return ServerResponse.error("Group ID is required"); } const result = await MiroClient.getApi().getGroupById(boardId, groupId); return ServerResponse.text(JSON.stringify(result, null, 2)); } catch (error) { process.stderr.write(`Error retrieving group: ${error}\n`); return ServerResponse.error(error); } }
- src/tools/getGroup.ts:6-12 (schema)The ToolSchema definition for "get-group", including name, description, and input schema (args) validated with Zod.const getGroupTool: ToolSchema = { name: "get-group", description: "Retrieve information about 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 that you want to retrieve") },
- src/index.ts:180-180 (registration)Registers the getGroupTool ("get-group") with the ToolBootstrapper instance..register(getGroupTool)