Skip to main content
Glama
Sign In
zendesk-mcp

zendesk-mcp

by michaelrice
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

zendesk_preview_macro

Preview how a Zendesk macro will affect a ticket before applying it, returning the exact result payload from the preview endpoint.

Instructions

Preview the effect a macro would have (without applying it). Returns the result payload from Zendesk's apply preview endpoint.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "macro_id": "<macro_id>"
    },
    "name": "zendesk_preview_macro"
  }
}

Input Schema

NameRequiredDescriptionDefault
macro_idYes

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.1.1

TDQS

A3.8/5.0
Behavior3/5

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

No annotations are provided, so the description carries the behavioral disclosure burden. It correctly indicates the tool is a preview (no side effects) and returns a payload, but it does not mention authentication, rate limits, or other behavioral traits.

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

Conciseness5/5

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

The description is a single sentence that is front-loaded with the key action. No extraneous information is present; every word earns its place.

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

Completeness5/5

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

Given the tool's simplicity (one parameter, no nested objects, output schema present), the description is complete. It explains the purpose, what it does (preview without applying), and what it returns. No additional context is necessary.

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

Parameters2/5

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

The input schema has zero description coverage for the parameter 'macro_id'. The description does not elaborate on the parameter beyond the name, which is self-explanatory but adds no additional semantics to compensate for the lack of schema description.

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

Purpose5/5

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

The description clearly states the action ('preview'), the resource ('macro'), and distinguishes it from the sibling 'apply_macro' by noting that it does not apply the macro. It is specific and unambiguous.

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

Usage Guidelines3/5

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

The description hints at when to use this tool ('without applying it') but does not provide explicit guidance on when not to use it or mention alternatives. Usage context is implied rather than stated.

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

Deploy Server

Other Tools