Skip to main content
Glama

Meta Council

by com.meta-council
OverviewDiscussionsAdmin

Ticket Comment

ticket_comment

Add a comment to an owned ticket's activity trail. Use kind='progress' for work updates while a ticket is in progress. The authenticated API-key UUID is stamped as author; callers cannot supply or spoof it. Open the comment in plain language before any technical detail — these are read during escalations by people who were not part of the work.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bodyYesComment text (Markdown ok). Lead with a plain-language summary: what changed as observable behaviour, and what still needs a human decision — or say plainly that nothing does. Keep SHAs, paths and symbol names out of that opening; put them in the detail below it.
kindNo
ticket_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -{
-  "additionalProperties": false,
-  "properties": {
-    "text": {
-      "type": "string"
-    }
-  },
-  "required": [
-    "text"
-  ],
-  "type": "object"
-}New value: +null
  2. Changed1 schema field changed
    • addedInput schema / properties / body / description
      Added value: +"Comment text (Markdown ok). Lead with a plain-language summary: what changed as observable behaviour, and what still needs a human decision — or say plainly that nothing does. Keep SHAs, paths and symbol names out of that opening; put them in the detail below it."
  3. Changed1 schema field changed
    • removedInput schema / properties / author
      Removed value: -{
-  "maxLength": 120,
-  "type": "string"
-}
  4. Added
  5. Removed
  6. Added

TDQS

A4.4/5.0
Behavior4/5

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

Beyond the annotations (all false), the description discloses a key behavioral trait: the authenticated API-key UUID is stamped as author and cannot be spoofed by the caller. It also adds operational context that comments are read during escalations by non-participants, which shapes how the body should be written. No contradictions with annotations.

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 three focused sentences, each earning its place: purpose, kind semantics, author stamping, and writing guidance. It is front-loaded with the core action and avoids any fluff.

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 relatively simple write operation, the description covers the essential invocation constraints: ownership, kind usage, author identity, and body composition. With no output schema, it does not describe return values, and it omits potential error conditions, but nothing critical is missing for a correct call.

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?

With only 33% schema coverage, the description compensates by explaining the meaning of kind ('progress' for work updates) and implying ticket_id must refer to an owned ticket. It also reinforces the writing guidance for body, which already exists in the schema, and adds the ownership constraint not present in the schema.

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 opens with a specific verb and resource: 'Add a comment to an owned ticket's activity trail.' This clearly distinguishes it from sibling tools like ticket_update or ticket_create, and the ownership constraint narrows the scope appropriately. No ambiguity about what the tool does.

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?

The description gives clear contextual guidance: use kind='progress' for work updates during an in-progress ticket, and implies this tool is the correct place for adding activity-trail comments. It does not explicitly name alternatives or state when not to use the tool, but the context is strong enough for an agent to select it appropriately among the ticket_* siblings.

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

All Meta Council toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources