list_chats
Retrieve and manage chat conversations from Zendesk with pagination controls for efficient navigation through support interactions.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination | |
| per_page | No | Number of chats per page (max 100) |
Implementation Reference
- src/tools/chat.js:12-28 (handler)The handler function that executes the list_chats tool logic. It prepares parameters, calls zendeskClient.listChats, and returns the result as JSON or an error message.handler: async ({ page, per_page }) => { try { const params = { page, per_page }; const result = await zendeskClient.listChats(params); return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] }; } catch (error) { return { content: [{ type: "text", text: `Error listing chats: ${error.message}` }], isError: true }; } }
- src/tools/chat.js:8-11 (schema)Zod schema defining the optional input parameters 'page' and 'per_page' for pagination.schema: { page: z.number().optional().describe("Page number for pagination"), per_page: z.number().optional().describe("Number of chats per page (max 100)") },
- src/tools/chat.js:4-30 (registration)The list_chats tool is defined and exported as part of the chatTools array, which is later imported and registered in the MCP server.export const chatTools = [ { name: "list_chats", description: "List Zendesk Chat conversations", schema: { page: z.number().optional().describe("Page number for pagination"), per_page: z.number().optional().describe("Number of chats per page (max 100)") }, handler: async ({ page, per_page }) => { try { const params = { page, per_page }; const result = await zendeskClient.listChats(params); return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] }; } catch (error) { return { content: [{ type: "text", text: `Error listing chats: ${error.message}` }], isError: true }; } } } ];
- src/zendesk-client.js:287-289 (helper)The underlying ZendeskClient method that performs the API request to list chats, called by the tool handler.async listChats(params) { return this.request("GET", "/chats.json", null, params); }
- src/server.js:48-52 (registration)Generic registration loop where all tools, including list_chats from chatTools, are registered with the MCP server using server.tool.allTools.forEach((tool) => { server.tool(tool.name, tool.schema, tool.handler, { description: tool.description, }); });