update-board
Modify an existing Miro board by updating its name, description, sharing policy, or team assignment using the board ID.
Instructions
Update an existing Miro board with new settings
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| boardId | Yes | Unique identifier (ID) of the board that you want to update | |
| name | No | New name for the board | |
| description | No | New description for the board | |
| sharingPolicy | No | New sharing policy for the board | |
| teamId | No | New team ID to assign the board to |
Implementation Reference
- src/tools/updateBoard.ts:16-35 (handler)The main handler function for the 'update-board' tool. It checks for required boardId, builds the changes object from optional params, calls MiroClient to update the board, and returns the result or error response.
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:9-15 (schema)Zod-based input schema defining parameters for updating a board: required boardId, optional name, description, sharingPolicy, and teamId.
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)Registers the updateBoardTool (imported from './tools/updateBoard.js') with the ToolBootstrapper in the main index file.
.register(updateBoardTool)