Skip to main content
Glama

List ticket comments

list_ticket_comments
Read-onlyIdempotent

Retrieve all comments for a ticket to see author, date, internal flag, and text. Use page and full-field parameters for audits or troubleshooting.

Instructions

Conversation of a ticket: author, date, internal flag and text of each comment.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
fullNoReturn every field of each item instead of a summary (much larger output)
pageNoPage number, starting at 1 (default 1)
ticketIdYesTicket ID
itemsInPageNoItems per page (default 20, max 50)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.1

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, covering the safety profile. The description adds useful content-level context by disclosing the fields returned (author, date, internal flag, text), but says nothing about pagination behavior, ordering, or the significance of the internal flag.

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

Conciseness4/5

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

A single tight sentence that front-loads the resource and lists the salient returned fields without waste. It is appropriately sized for a simple read tool.

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 read-only list tool with rich annotations and 100% schema coverage, no output schema is needed and the description adequately conveys what comes back. It could be stronger by noting pagination (the schema exposes page/itemsInPage) or the meaning of the internal flag, but it is broadly complete.

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 description coverage is 100%, so full, page, ticketId, and itemsInPage are all documented in the schema, including defaults and max values. The description adds no parameter-level meaning beyond that, so the baseline of 3 applies.

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

Purpose4/5

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

The description names the resource (a ticket's conversation) and enumerates the returned fields (author, date, internal flag, text), which clearly identifies it as a comment-listing tool distinct from siblings like list_ticket_attachments. It lacks an explicit verb, relying on the title, and doesn't explicitly differentiate from get_ticket, but the purpose is unambiguous.

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

Usage Guidelines2/5

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

There is no when-to-use guidance, no mention of prerequisites (a valid ticketId), and no reference to alternative tools such as get_ticket or list_ticket_attachments. The agent must infer usage from the name alone.

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