Skip to main content
Glama

get-board-export-job-results

Retrieve exported board data from Miro by providing organization and job IDs for enterprise users.

Instructions

Retrieves the results of a board export job (Enterprise only)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
orgIdYesUnique identifier of the organization
jobIdYesUnique identifier of the job

Implementation Reference

  • The handler function that retrieves board export job results using MiroClient API, formats the response as JSON, and handles errors.
    fn: async ({ orgId, jobId }) => {
      try {
        const response = await MiroClient.getApi().enterpriseBoardExportJobResults(orgId, jobId);
    
        return ServerResponse.text(JSON.stringify(response.body, null, 2));
      } catch (error) {
        process.stderr.write(`Error retrieving board export job results: ${error}\n`);
        return ServerResponse.error(error);
      }
    }
  • Tool schema definition including name, description, and Zod input schema for orgId and jobId.
    const getBoardExportJobResultsTool: ToolSchema = {
      name: "get-board-export-job-results",
      description: "Retrieves the results of a board export job (Enterprise only)",
      args: {
        orgId: z.string().describe("Unique identifier of the organization"),
        jobId: z.string().describe("Unique identifier of the job")
      },
  • src/index.ts:194-194 (registration)
    Registers the getBoardExportJobResultsTool with the ToolBootstrapper instance.
    .register(getBoardExportJobResultsTool)
Behavior2/5

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

No annotations are provided, so the description must fully disclose behavior. It states 'Retrieves', implying a read operation, but lacks details on permissions, rate limits, response format, or error handling. The 'Enterprise only' note adds some context about access restrictions, but overall behavioral traits are minimally covered, leaving significant gaps for a tool with no annotation support.

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

Conciseness5/5

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

The description is a single, efficient sentence with no wasted words. It front-loads the core action and resource, and the 'Enterprise only' note is succinctly appended. Every part earns its place, making it highly concise and well-structured for quick understanding.

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?

Given no annotations and no output schema, the description is incomplete for a tool that retrieves job results. It lacks details on what the results contain, how they're formatted, error cases, or dependencies on other tools like 'create-board-export-job'. The 'Enterprise only' note is helpful but insufficient to compensate for the missing behavioral and output 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?

The input schema has 100% description coverage, with clear documentation for 'orgId' and 'jobId'. The description adds no additional parameter details beyond what the schema provides, such as format examples or relationships between parameters. This meets the baseline of 3 since the schema does the heavy lifting, but no extra value is contributed.

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 ('Retrieves') and the resource ('results of a board export job'), making the purpose specific and understandable. It distinguishes from siblings like 'get-board-export-job-status' by focusing on results rather than status, though it doesn't explicitly compare them. The 'Enterprise only' note adds context but doesn't fully differentiate from all siblings.

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 no guidance on when to use this tool versus alternatives like 'get-board-export-job-status' or other job-related tools. It mentions 'Enterprise only', which hints at a prerequisite, but offers no explicit when/when-not instructions or comparisons to sibling tools, leaving usage unclear.

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