list_articles
Retrieve and manage Zendesk Help Center articles using pagination and sorting options to organize knowledge base content.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination | |
| per_page | No | Number of articles per page (max 100) | |
| sort_by | No | Field to sort by | |
| sort_order | No | Sort order (asc or desc) |
Implementation Reference
- src/tools/help-center.js:14-30 (handler)The handler function for the 'list_articles' tool. It constructs parameters, calls the Zendesk client to list articles, and returns the JSON-formatted result or an error message.handler: async ({ page, per_page, sort_by, sort_order }) => { try { const params = { page, per_page, sort_by, sort_order }; const result = await zendeskClient.listArticles(params); return { content: [{ type: "text", text: JSON.stringify(result, null, 2) }] }; } catch (error) { return { content: [{ type: "text", text: `Error listing articles: ${error.message}` }], isError: true }; } }
- src/tools/help-center.js:8-13 (schema)Zod schema defining optional input parameters for pagination and sorting of articles.schema: { page: z.number().optional().describe("Page number for pagination"), per_page: z.number().optional().describe("Number of articles per page (max 100)"), sort_by: z.string().optional().describe("Field to sort by"), sort_order: z.enum(["asc", "desc"]).optional().describe("Sort order (asc or desc)") },
- src/server.js:48-52 (registration)Registers the 'list_articles' tool (along with others from helpCenterTools) to the MCP server using server.tool().allTools.forEach((tool) => { server.tool(tool.name, tool.schema, tool.handler, { description: tool.description, }); });
- src/server.js:41-41 (registration)Includes helpCenterTools (containing list_articles) in the allTools array for registration....helpCenterTools,
- src/zendesk-client.js:255-257 (helper)Helper method in ZendeskClient that performs the HTTP GET request to the Zendesk Help Center articles endpoint.async listArticles(params) { return this.request("GET", "/help_center/articles.json", null, params); }