zendesk_ticket_to_gitlab_context

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

With no annotations, the description carries full burden. It states the tool returns Markdown (a read operation) and describes the output sections. It does not mention side effects, but given the nature of formatting, the absence is acceptable. The description could add that it does not modify the ticket.

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?

Two sentences with no wasted words. The first sentence states purpose and output format; the second provides usage instruction. Ideal conciseness.

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?

For a simple one-parameter tool with an output schema, the description covers purpose, output content, and usage. It lacks details on error conditions or edge cases but is sufficient for the tool's complexity.

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 description links the ticket_id parameter to the ticket being formatted and mentions that comments are included, adding meaning beyond the schema's 'ticket_id' name. With schema coverage at 0%, this compensates well, though it could specify that ticket_id must exist.

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 the tool formats a Zendesk ticket and its comments as a Markdown issue draft with ticket metadata, conversation, and Steps to Reproduce. This is a specific verb+resource that distinguishes it from sibling tools like zendesk_get_ticket or zendesk_create_ticket.

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 explicitly says 'Use this output as the description when creating an issue in your tracker,' providing a clear use case. However, it does not mention when not to use it or name alternative tools, leaving room for improvement.

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