get-all-legal-holds
Retrieve all legal holds for a specific case within an organization to manage compliance and legal requirements.
Instructions
Retrieves the list of all legal holds within a case (Enterprise only)
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | Yes | The maximum number of items in the result list | |
| orgId | Yes | The ID of the organization for which you want to retrieve the list of legal holds | |
| caseId | Yes | The ID of the case for which you want to retrieve the list of legal holds | |
| cursor | No | Cursor for pagination |
Implementation Reference
- src/tools/getAllLegalHolds.ts:15-27 (handler)The main handler function that implements the tool's logic. It constructs a query, calls the Miro API's getAllLegalHolds method, and handles the response or error.
fn: async ({ limit, orgId, caseId, cursor }) => { try { const query: any = {}; if (cursor) query.cursor = cursor; const response = await MiroClient.getApi().getAllLegalHolds(limit, orgId, caseId, query); return ServerResponse.text(JSON.stringify(response.body, null, 2)); } catch (error) { process.stderr.write(`Error retrieving legal holds: ${error}\n`); return ServerResponse.error(error); } } - src/tools/getAllLegalHolds.ts:6-14 (schema)The ToolSchema definition including the tool name, description, and Zod schemas for input arguments (limit, orgId, caseId, cursor).
const getLegalHoldsTool: ToolSchema = { name: "get-all-legal-holds", description: "Retrieves the list of all legal holds within a case (Enterprise only)", args: { limit: z.number().describe("The maximum number of items in the result list"), orgId: z.string().describe("The ID of the organization for which you want to retrieve the list of legal holds"), caseId: z.string().describe("The ID of the case for which you want to retrieve the list of legal holds"), cursor: z.string().optional().nullish().describe("Cursor for pagination") }, - src/index.ts:103-103 (registration)Import of the get-all-legal-holds tool module.
import getLegalHoldsTool from './tools/getAllLegalHolds.js'; - src/index.ts:204-204 (registration)Registration of the get-all-legal-holds tool with the ToolBootstrapper instance.
.register(getLegalHoldsTool)