update_article
Modify existing Zendesk help articles by updating content, metadata, and visibility settings to maintain accurate support documentation.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Article ID to update | |
| title | No | Updated article title | |
| body | No | Updated article body content (HTML) | |
| locale | No | Updated article locale (e.g., 'en-us') | |
| draft | No | Whether the article is a draft | |
| permission_group_id | No | Updated permission group ID | |
| user_segment_id | No | Updated user segment ID | |
| label_names | No | Updated labels |
Implementation Reference
- src/tools/help-center.js:108-133 (handler)The async handler function for the 'update_article' MCP tool. Processes optional input parameters to build article update data, calls the zendeskClient.updateArticle method, and returns a formatted success or error response.handler: async ({ id, title, body, locale, draft, permission_group_id, user_segment_id, label_names }) => { try { const articleData = {}; if (title !== undefined) articleData.title = title; if (body !== undefined) articleData.body = body; if (locale !== undefined) articleData.locale = locale; if (draft !== undefined) articleData.draft = draft; if (permission_group_id !== undefined) articleData.permission_group_id = permission_group_id; if (user_segment_id !== undefined) articleData.user_segment_id = user_segment_id; if (label_names !== undefined) articleData.label_names = label_names; const result = await zendeskClient.updateArticle(id, articleData); return { content: [{ type: "text", text: `Article updated successfully!\n\n${JSON.stringify(result, null, 2)}` }] }; } catch (error) { return { content: [{ type: "text", text: `Error updating article: ${error.message}` }], isError: true }; } }
- src/tools/help-center.js:98-107 (schema)Zod schema defining the input parameters for the 'update_article' tool, including required article ID and optional fields for title, body, locale, draft status, permissions, segments, and labels.schema: { id: z.number().describe("Article ID to update"), title: z.string().optional().describe("Updated article title"), body: z.string().optional().describe("Updated article body content (HTML)"), locale: z.string().optional().describe("Updated article locale (e.g., 'en-us')"), draft: z.boolean().optional().describe("Whether the article is a draft"), permission_group_id: z.number().optional().describe("Updated permission group ID"), user_segment_id: z.number().optional().describe("Updated user segment ID"), label_names: z.array(z.string()).optional().describe("Updated labels") },
- src/server.js:48-52 (registration)Registration loop that dynamically registers all tools, including 'update_article' from helpCenterTools, to the MCP server using server.tool with the tool's name, schema, handler, and description.allTools.forEach((tool) => { server.tool(tool.name, tool.schema, tool.handler, { description: tool.description, }); });
- src/zendesk-client.js:271-275 (helper)Helper method in ZendeskClient that performs the actual PUT request to the Zendesk Help Center API to update the specified article with the provided data.async updateArticle(id, data) { return this.request("PUT", `/help_center/articles/${id}.json`, { article: data, }); }