update_article
Modifies Zendesk Guide articles by updating title, body, locale, draft status, permissions, user segments, and labels via a structured API call using the article ID.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | No | Updated article body content (HTML) | |
| draft | No | Whether the article is a draft | |
| id | Yes | Article ID to update | |
| label_names | No | Updated labels | |
| locale | No | Updated article locale (e.g., 'en-us') | |
| permission_group_id | No | Updated permission group ID | |
| title | No | Updated article title | |
| user_segment_id | No | Updated user segment ID |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"body": {
"description": "Updated article body content (HTML)",
"type": "string"
},
"draft": {
"description": "Whether the article is a draft",
"type": "boolean"
},
"id": {
"description": "Article ID to update",
"type": "number"
},
"label_names": {
"description": "Updated labels",
"items": {
"type": "string"
},
"type": "array"
},
"locale": {
"description": "Updated article locale (e.g., 'en-us')",
"type": "string"
},
"permission_group_id": {
"description": "Updated permission group ID",
"type": "number"
},
"title": {
"description": "Updated article title",
"type": "string"
},
"user_segment_id": {
"description": "Updated user segment ID",
"type": "number"
}
},
"required": [
"id"
],
"type": "object"
}
Implementation Reference
- src/tools/help-center.js:108-132 (handler)The async handler function for the 'update_article' MCP tool. Constructs optional article data from inputs and delegates to zendeskClient.updateArticle, formatting success/error responses.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 input schema for the 'update_article' tool, defining required article ID and optional update fields.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:47-52 (registration)Tool registration loop in the MCP server that registers the 'update_article' tool (included in helpCenterTools spread into allTools) using server.tool(name, schema, handler).// Register each tool with the server allTools.forEach((tool) => { server.tool(tool.name, tool.schema, tool.handler, { description: tool.description, }); });
- src/zendesk-client.js:271-275 (helper)ZendeskClient helper method that sends a PUT request to the Zendesk Help Center API to update the specified article.async updateArticle(id, data) { return this.request("PUT", `/help_center/articles/${id}.json`, { article: data, }); }