list_articles
Retrieve and manage Zendesk articles with pagination, sorting, and filtering options for efficient content organization and access.
Input 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) |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"page": {
"description": "Page number for pagination",
"type": "number"
},
"per_page": {
"description": "Number of articles per page (max 100)",
"type": "number"
},
"sort_by": {
"description": "Field to sort by",
"type": "string"
},
"sort_order": {
"description": "Sort order (asc or desc)",
"enum": [
"asc",
"desc"
],
"type": "string"
}
},
"type": "object"
}
Implementation Reference
- src/tools/help-center.js:14-30 (handler)The asynchronous handler function for the 'list_articles' MCP tool. Constructs parameters, calls zendeskClient.listArticles(params), formats the result as JSON text content, or returns an error.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 the input parameters for the list_articles tool: optional page, per_page, sort_by, and sort_order.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/tools/help-center.js:5-31 (registration)Complete tool object definition for 'list_articles' within the exported helpCenterTools array, which is imported into src/server.js and registered via server.tool().{ name: "list_articles", description: "List Help Center 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)") }, 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/zendesk-client.js:255-257 (helper)ZendeskClient helper method that performs the actual API GET request to /help_center/articles.json with provided parameters.async listArticles(params) { return this.request("GET", "/help_center/articles.json", null, params); }