Skip to main content
Glama
Sign In
Zendesk MCP Server

Zendesk MCP Server

by rlowndes9
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Remote

get_user_field

Read-onlyIdempotent

Retrieve a user field schema entry by its ID. Use this to inspect custom user field definitions, not the field values on users.

Instructions

Fetch one user-field schema entry by ID with full body. Distinct from a value on a user, for that, fetch the user and read user_fields.

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": {
      "id": "<id>"
    },
    "name": "get_user_field"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesUser field ID
instanceNoOverride the sticky instance for this call

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.2/5.0
Behavior3/5

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

Annotations already indicate readOnlyHint, openWorldHint, and idempotentHint. The description adds the distinction from user field values but does not disclose additional behaviors such as error handling, rate limits, or pagination. Given the annotations, this is adequate but not rich.

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 two sentences, front-loaded with the core action, and contains no wasted words. Every sentence serves a purpose.

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

Completeness4/5

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

For a simple read-by-ID tool with 2 parameters and no output schema, the description covers the essential context: what it does, when to use it, and how it differs from a related concept. It does not describe error cases or return structure, but that is acceptable given the tool's simplicity and the presence of annotations.

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

Parameters3/5

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

Schema coverage is 100% with descriptions for both parameters. The description does not add extra meaning beyond stating 'by ID', which is already implied. It does not elaborate on the id or instance parameters, so baseline 3 is appropriate.

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 it fetches a user-field schema entry by ID with full body, using a specific verb and resource. It explicitly distinguishes this from fetching a user field value on a user, differentiating it from sibling tools like get_user and list_user_fields.

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

Usage Guidelines5/5

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

The description provides explicit guidance: use this tool to fetch a schema entry, but for a field value on a user, instead fetch the user and read user_fields. This helps the agent choose correctly among siblings like get_user.

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