zendesk_get_git_zen_links

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

No annotations are provided, so the description must convey behavioral traits. It clearly describes a read operation returning structured lists. However, it lacks details about prerequisites (e.g., ticket must have Git-Zen links), error handling, or authentication needs.

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

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

The description is two sentences with no extraneous information. It is front-loaded with the action and resource, making it efficient for an agent to parse.

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

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

Given the single parameter, presence of output schema, and no annotations, the description covers the core functionality. It could mention that the tool is only relevant for tickets with Git-Zen integration or include example usage, but it is sufficient for a simple retrieval tool.

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

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

The input schema has one required parameter (ticket_id) with no description (schema coverage 0%). The tool description does not explain the parameter, leaving the agent to infer from the name. While 'ticket_id' is obvious, the description adds no value beyond the schema.

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

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

The description clearly states it gets linked GitLab issues, merge requests, and commits for a Zendesk ticket, specifying the integration (Git-Zen) and what is returned (state, labels, weight, links). This distinguishes it from sibling tools like zendesk_get_ticket or zendesk_ticket_to_gitlab_context.

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

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

The description implies usage for Zendesk tickets with Git-Zen integration but does not explicitly state when to use this tool versus alternatives like zendesk_ticket_to_gitlab_context. No when-not-to-use guidance is provided.

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