create-board-export-job
Initiate an export job for multiple boards in PDF or CSV format on the Miro MCP server by specifying organization ID, request ID, and board IDs.
Instructions
Creates an export job for one or more boards (Enterprise only)
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| boardIds | Yes | Array of board IDs to export | |
| format | No | Export format (default: pdf) | |
| orgId | Yes | Unique identifier of the organization | |
| requestId | Yes | Unique identifier of the board export job |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"boardIds": {
"description": "Array of board IDs to export",
"items": {
"type": "string"
},
"type": "array"
},
"format": {
"description": "Export format (default: pdf)",
"enum": [
"pdf",
"csv"
],
"type": "string"
},
"orgId": {
"description": "Unique identifier of the organization",
"type": "string"
},
"requestId": {
"description": "Unique identifier of the board export job",
"type": "string"
}
},
"required": [
"orgId",
"requestId",
"boardIds"
],
"type": "object"
}
Implementation Reference
- src/tools/createBoardExportJob.ts:15-33 (handler)Handler function that executes the tool logic: calls Miro API to create export job for boards.fn: async ({ orgId, requestId, boardIds, format }) => { try { const createBoardExportRequest = { boardIds: boardIds, ...(format && { format: format }) }; const response = await MiroClient.getApi().enterpriseCreateBoardExport( orgId, requestId, createBoardExportRequest ); return ServerResponse.text(JSON.stringify(response.body, null, 2)); } catch (error) { process.stderr.write(`Error creating board export job: ${error}\n`); return ServerResponse.error(error); } }
- Zod schema defining input parameters for the tool.orgId: z.string().describe("Unique identifier of the organization"), requestId: z.string().describe("Unique identifier of the board export job"), boardIds: z.array(z.string()).describe("Array of board IDs to export"), format: z.enum(["pdf", "csv"]).optional().nullish().describe("Export format (default: pdf)") },
- src/index.ts:192-192 (registration)Registers the tool in the ToolBootstrapper..register(createBoardExportJobTool)