get_list_readrequest
Poll the status of a large volume list read request and get notified when complete for page download.
Instructions
Poll status of a large volume list read. When status is COMPLETE, use get_list_readrequest_page to download each page. requestId comes from create_list_readrequest response.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| workspaceId | Yes | Anaplan workspace ID or name | |
| modelId | Yes | Anaplan model ID or name | |
| listId | Yes | List ID or name | |
| requestId | Yes | Read request ID (from create_list_readrequest response) |
Implementation Reference
- src/tools/bulk.ts:523-534 (handler)The MCP tool handler for 'get_list_readrequest'. Registers the tool with Zod schema for workspaceId, modelId, listId, and requestId, then calls the API and returns the JSON response.
server.tool("get_list_readrequest", "Poll status of a large volume list read. When status is COMPLETE, use get_list_readrequest_page to download each page. requestId comes from create_list_readrequest response.", { workspaceId: z.string().describe("Anaplan workspace ID or name"), modelId: z.string().describe("Anaplan model ID or name"), listId: z.string().describe("List ID or name"), requestId: z.string().describe("Read request ID (from create_list_readrequest response)"), }, async ({ workspaceId, modelId, listId, requestId }) => { const wId = await resolver.resolveWorkspace(workspaceId); const mId = await resolver.resolveModel(wId, modelId); const lId = await resolver.resolveList(wId, mId, listId); const result = await apis.largeReads.getListReadRequest(wId, mId, lId, requestId); return { content: [{ type: "text" as const, text: JSON.stringify(result.listReadRequest ?? result, null, 2) }] }; }); - src/tools/bulk.ts:524-527 (schema)Input schema/validation for get_list_readrequest using Zod schema with four string parameters: workspaceId, modelId, listId, and requestId.
workspaceId: z.string().describe("Anaplan workspace ID or name"), modelId: z.string().describe("Anaplan model ID or name"), listId: z.string().describe("List ID or name"), requestId: z.string().describe("Read request ID (from create_list_readrequest response)"), - src/api/largeReads.ts:79-89 (helper)The API helper method that executes the HTTP GET request to the Anaplan backend to fetch the list read request status.
async getListReadRequest( workspaceId: string, modelId: string, listId: string, requestId: string ) { const res = await this.client.get<any>( `/workspaces/${workspaceId}/models/${modelId}/lists/${listId}/readRequests/${requestId}` ); return res.listReadRequest ?? res; } - src/server.ts:59-61 (registration)Registration of bulk tools including get_list_readrequest via registerBulkTools, which wires the tool into the MCP server.
registerBulkTools(server, { imports, exports, processes, files, client, modelManagement, calendar, versions, lists, largeReads, actions, optimizer, }, resolver);