Skip to main content
Glama

Comment on a ticket

officernd_add_ticket_comment
Destructive

WRITE. Post a comment on a helpdesk ticket. Public comments are visible to the member; comments attributed to members must be public. Needs scope flex.collaboration.ticketComments.create. OfficeRnD: POST /ticket-comments/{ticketId}.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
textYesThe comment text.
memberYesThe _id of the member the comment is posted as.
is_publicYesWhether the comment is public (visible to the member).
ticket_idYesThe ticket _id.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Adds real context beyond the destructiveHint annotation: the required OAuth scope 'flex.collaboration.ticketComments.create', the endpoint, and the visibility rule for public vs member-attributed comments. It does not explain irreversibility or rate limits, but the annotations already carry the destructive signal.

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?

Front-loaded with the WRITE marker and the core action, then constraints and auth. Four compact sentences with little waste, though the raw endpoint string adds marginal value.

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 write tool with annotations and no output schema, the description covers action, scope, endpoint, and a key visibility constraint. Return behavior and error handling are omitted but are not essential for correct invocation.

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

Parameters4/5

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

Schema coverage is 100% so the baseline is 3, but the description adds a cross-parameter constraint tying 'member' to 'is_public' that the schema does not express. That is meaningful semantics beyond the field-level docs.

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?

States a specific verb and resource ('Post a comment on a helpdesk ticket') and the WRITE prefix immediately signals the operation class. It is clearly distinguishable from siblings like create_ticket or list_tickets.

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

Usage Guidelines4/5

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

Provides a clear business rule for the operation ('comments attributed to members must be public') and marks it as a write, but never names a when-not condition or an alternative tool. There is no competing sibling for commenting, so context is adequate.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.