update-board
Modify Miro board settings by updating its name, description, sharing policy, or team assignment. Use this tool to manage board configurations efficiently via the Miro MCP server.
Instructions
Update an existing Miro board with new settings
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| boardId | Yes | Unique identifier (ID) of the board that you want to update | |
| description | No | New description for the board | |
| name | No | New name for the board | |
| sharingPolicy | No | New sharing policy for the board | |
| teamId | No | New team ID to assign the board to |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"boardId": {
"description": "Unique identifier (ID) of the board that you want to update",
"type": "string"
},
"description": {
"description": "New description for the board",
"type": "string"
},
"name": {
"description": "New name for the board",
"type": "string"
},
"sharingPolicy": {
"description": "New sharing policy for the board",
"enum": [
"private",
"view",
"comment",
"edit"
],
"type": "string"
},
"teamId": {
"description": "New team ID to assign the board to",
"type": "string"
}
},
"required": [
"boardId"
],
"type": "object"
}
Implementation Reference
- src/tools/updateBoard.ts:16-35 (handler)The main handler function for the 'update-board' tool. It validates the boardId, builds the update payload from optional parameters, calls MiroClient.getApi().updateBoard, and returns the result or error.fn: async ({ boardId, name, description, sharingPolicy, teamId }) => { try { if (!boardId) { return ServerResponse.error("Board ID is required"); } const boardChanges = {}; if (name) boardChanges['name'] = name; if (description !== undefined) boardChanges['description'] = description; if (sharingPolicy) boardChanges['sharingPolicy'] = { access: sharingPolicy }; if (teamId) boardChanges['teamId'] = teamId; const boardData = await MiroClient.getApi().updateBoard(boardId, boardChanges); return ServerResponse.text(JSON.stringify(boardData, null, 2)); } catch (error) { process.stderr.write(`Error updating Miro board: ${error}\n`); return ServerResponse.error(error); } }
- src/tools/updateBoard.ts:6-15 (schema)The ToolSchema object defining the tool name, description, and Zod input schema for parameters.const updateBoardTool: ToolSchema = { name: "update-board", description: "Update an existing Miro board with new settings", args: { boardId: z.string().describe("Unique identifier (ID) of the board that you want to update"), name: z.string().optional().nullish().describe("New name for the board"), description: z.string().optional().nullish().describe("New description for the board"), sharingPolicy: z.enum(['private', 'view', 'comment', 'edit']).optional().nullish().describe("New sharing policy for the board"), teamId: z.string().optional().nullish().describe("New team ID to assign the board to") },
- src/index.ts:113-113 (registration)Registration of the 'update-board' tool with the ToolBootstrapper instance in the main index file..register(updateBoardTool)