get-all-board-members
Retrieve all members of a specific Miro board using board ID. Supports pagination with limit and offset parameters for efficient data handling.
Instructions
Retrieve all members of a specific Miro board
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| boardId | Yes | ID of the board to retrieve members from | |
| limit | No | Maximum number of members to retrieve (default: 50) | |
| offset | No | Offset for pagination (default: 0) |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"boardId": {
"description": "ID of the board to retrieve members from",
"type": "string"
},
"limit": {
"description": "Maximum number of members to retrieve (default: 50)",
"type": "number"
},
"offset": {
"description": "Offset for pagination (default: 0)",
"type": "number"
}
},
"required": [
"boardId"
],
"type": "object"
}
Implementation Reference
- src/tools/getAllBoardMembers.ts:14-30 (handler)The asynchronous handler function that implements the core logic of the 'get-all-board-members' tool. It fetches board members using the MiroClient API with pagination support and handles errors appropriately.fn: async ({ boardId, limit = 50, offset = 0 }) => { try { if (!boardId) { return ServerResponse.error("Board ID is required"); } const result = await MiroClient.getApi().getBoardMembers(boardId, { limit: limit.toString(), offset: offset.toString() }); return ServerResponse.text(JSON.stringify(result, null, 2)); } catch (error) { process.stderr.write(`Error retrieving board members: ${error}\n`); return ServerResponse.error(error); } }
- src/tools/getAllBoardMembers.ts:9-13 (schema)Zod-based input schema defining the arguments for the tool: required boardId (string), optional limit and offset (numbers) with descriptions.args: { boardId: z.string().describe("ID of the board to retrieve members from"), limit: z.number().optional().nullish().describe("Maximum number of members to retrieve (default: 50)"), offset: z.number().optional().nullish().describe("Offset for pagination (default: 0)") },
- src/index.ts:173-173 (registration)Registers the getAllBoardMembers ToolSchema instance with the ToolBootstrapper for use in the MCP server..register(getAllBoardMembers)