Skip to main content
Glama

create-board-export-job

Export Miro boards to PDF or CSV format by creating a batch export job for enterprise organizations. Specify board IDs and format to generate downloadable exports.

Instructions

Creates an export job for one or more boards (Enterprise only)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
orgIdYesUnique identifier of the organization
requestIdYesUnique identifier of the board export job
boardIdsYesArray of board IDs to export
formatNoExport format (default: pdf)

Implementation Reference

  • The asynchronous handler function that creates an export job for specified boards using the Miro Enterprise API.
    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 the input arguments for the create-board-export-job tool.
    args: {
      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 createBoardExportJobTool with the ToolBootstrapper in the main index file.
    .register(createBoardExportJobTool)
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries full burden but only states it 'Creates an export job' without detailing behavioral traits. It lacks information on permissions required, whether this is asynchronous (implied by 'job'), rate limits, what 'Enterprise only' entails, or what the job creation actually does (e.g., triggers background processing).

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence that front-loads the core purpose. 'Enterprise only' adds necessary context without verbosity. However, it could be slightly more structured by explicitly separating functional and restriction aspects.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a tool with 4 parameters, no annotations, and no output schema, the description is insufficient. It doesn't explain what an 'export job' entails, what formats are supported (only implied by schema), how to retrieve results (though siblings exist), or error conditions. The 'Enterprise only' hint is helpful but doesn't compensate for missing behavioral context.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so parameters are well-documented in the schema itself. The description adds no additional parameter semantics beyond implying 'boardIds' can handle multiple boards ('one or more'). This meets the baseline for high schema coverage without compensating value.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('Creates an export job') and resource ('for one or more boards'), with the 'Enterprise only' qualifier adding specificity. However, it doesn't distinguish this from potential sibling tools like 'get-board-export-job-results' or 'get-board-export-job-status' beyond the creation aspect.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides minimal guidance with 'Enterprise only' indicating a usage restriction, but offers no explicit when-to-use advice, alternatives (e.g., vs. other export methods), or prerequisites. It doesn't help an agent decide between this and sibling tools like 'copy-board' or bulk operations.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/k-jarzyna/mcp-miro'

If you have feedback or need assistance with the MCP directory API, please join our Discord server