list_macros
Retrieve and manage Zendesk macros for automating support responses, with pagination controls to handle large datasets.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination | |
| per_page | No | Number of macros per page (max 100) |
Implementation Reference
- src/tools/macros.js:12-27 (handler)The handler function that implements the core logic of the 'list_macros' tool: constructs params from input, calls zendeskClient.listMacros, and returns formatted JSON response or error.
handler: async ({ page, per_page }) => { try { const params = { page, per_page }; const result = await zendeskClient.listMacros(params); return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] }; } catch (error) { return { content: [{ type: "text", text: `Error listing macros: ${error.message}` }], isError: true }; } - src/tools/macros.js:8-11 (schema)Input schema using Zod for validating optional 'page' and 'per_page' parameters of the list_macros tool.
schema: { page: z.number().optional().describe("Page number for pagination"), per_page: z.number().optional().describe("Number of macros per page (max 100)") }, - src/server.js:48-52 (registration)Registration loop that calls server.tool() for each tool in allTools, which includes the 'list_macros' tool from macrosTools spread earlier in the array.
allTools.forEach((tool) => { server.tool(tool.name, tool.schema, tool.handler, { description: tool.description, }); }); - src/zendesk-client.js:166-168 (helper)Supporting method in ZendeskClient class that handles the API request to list Zendesk macros, invoked by the list_macros tool handler.
async listMacros(params) { return this.request("GET", "/macros.json", null, params); }