Skip to main content
Glama
JurreBrandsenInfoSupport

Zendesk API MCP Server

update_article

Modify existing Zendesk help articles by updating content, metadata, and visibility settings to maintain accurate support documentation.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesArticle ID to update
titleNoUpdated article title
bodyNoUpdated article body content (HTML)
localeNoUpdated article locale (e.g., 'en-us')
draftNoWhether the article is a draft
permission_group_idNoUpdated permission group ID
user_segment_idNoUpdated user segment ID
label_namesNoUpdated labels

Implementation Reference

  • 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
        };
      }
    }
  • 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,
      });
    });
  • 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,
      });
    }
Behavior1/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Tool has no description.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness1/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Tool has no description.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness1/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Tool has no description.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters1/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Tool has no description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose1/5

Does the description clearly state what the tool does and how it differs from similar tools?

Tool has no description.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines1/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Tool has no description.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/JurreBrandsenInfoSupport/zendesk-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server