Skip to main content
Glama

get-legal-hold

Retrieve legal hold information from Miro by providing organization, case, and legal hold IDs for enterprise compliance needs.

Instructions

Retrieves information about a specific legal hold (Enterprise only)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
orgIdYesThe ID of the organization for which you want to retrieve the legal hold information
caseIdYesThe ID of the case for which you want to retrieve the legal hold information
legalHoldIdYesThe ID of the legal hold you want to retrieve

Implementation Reference

  • The asynchronous function that implements the core logic of the 'get-legal-hold' tool. It fetches legal hold information via MiroClient API and handles errors.
    fn: async ({ orgId, caseId, legalHoldId }) => {
      try {
        const response = await MiroClient.getApi().getLegalHold(orgId, caseId, legalHoldId);
    
        return ServerResponse.text(JSON.stringify(response.body, null, 2));
      } catch (error) {
        process.stderr.write(`Error retrieving legal hold: ${error}\n`);
        return ServerResponse.error(error);
      }
    }
  • Zod schema defining the input parameters for the 'get-legal-hold' tool: orgId, caseId, legalHoldId.
    args: {
      orgId: z.string().describe("The ID of the organization for which you want to retrieve the legal hold information"),
      caseId: z.string().describe("The ID of the case for which you want to retrieve the legal hold information"),
      legalHoldId: z.string().describe("The ID of the legal hold you want to retrieve")
    },
  • src/index.ts:205-205 (registration)
    The line where the get-legal-hold tool is registered with the ToolBootstrapper.
    .register(getLegalHoldTool)
  • src/index.ts:104-104 (registration)
    Import statement for the get-legal-hold tool module.
    import getLegalHoldTool from './tools/getLegalHold.js';
Behavior2/5

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

With no annotations provided, the description carries full burden for behavioral disclosure. It states this is a retrieval operation (read-only), which is adequate but minimal. It doesn't describe authentication needs, rate limits, error conditions, or what 'information' includes (e.g., metadata, status). For a tool with zero annotation coverage, this leaves significant gaps in understanding its behavior.

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 gets straight to the point. It's appropriately sized for a simple retrieval tool, with no wasted words. The 'Enterprise only' note is relevant and concise. However, it could be slightly more structured by separating scope from action.

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 retrieval tool with no annotations and no output schema, the description is incomplete. It doesn't explain what 'information' is returned (e.g., fields, format) or any behavioral nuances. While the schema covers inputs well, the lack of output details and minimal behavioral context makes this inadequate for full understanding.

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%, with all three parameters clearly documented in the schema. The description adds no parameter-specific information beyond what's in the schema (e.g., no examples, format details, or relationships between orgId/caseId/legalHoldId). Baseline 3 is appropriate when the schema does the heavy lifting.

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 verb ('Retrieves') and resource ('information about a specific legal hold'), making the purpose unambiguous. It distinguishes from sibling 'get-all-legal-holds' by specifying 'specific' rather than 'all', though it doesn't explicitly name the sibling. The 'Enterprise only' note adds useful scope but doesn't fully differentiate from alternatives.

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-all-legal-holds' or 'get-case'. It mentions 'Enterprise only' which indicates a prerequisite, but offers no explicit when/when-not instructions or named alternatives. Usage is implied rather than clearly defined.

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