Skip to main content
Glama

Write ticket announcement

announce
DestructiveIdempotent

Set what a ticket's done announcement tells the team: a one-line summary and how to use what was built, or skip: true. Call it before your ticket is done (assignee, PM or lead only); after done it rewrites the posted announcement.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "ticketKey": "<ticketKey>"
    },
    "name": "announce"
  }
}

Input Schema

NameRequiredDescriptionDefault
skipNotrue: do not announce this ticket
summaryNoWhat was built, in a sentence
howToUseNoHow teammates use it: commands, endpoints, tools
ticketKeyYesTicket key such as "LG-12" (or its id)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true and idempotentHint=true, so the safety profile is partly covered. The description adds genuinely new context: the authorization restriction, the pre-completion timing window, and that a post-done call rewrites an already-posted announcement rather than creating a separate one.

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?

Two tightly packed sentences with the purpose front-loaded and the operative constraints (timing, permissions, post-done behavior) following. No filler, no repetition of the title.

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 4-parameter mutation with no output schema, the description covers intent, timing, permissions and the rewrite side effect. It does not say what happens to the announcement when skip is later un-set, nor what the call returns, which is a minor gap for an idempotent writer.

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 coverage is 100%, so every parameter including ticketKey, skip, summary and howToUse is already documented in the schema. The description reinforces the summary/howToUse pairing and the skip flag but adds no format, length or precedence detail beyond that, so the baseline 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 gives a specific verb and resource: it sets the content of a ticket's done announcement (summary plus how-to-use), or suppresses it with skip. That is clearly distinct from lifecycle siblings like submit_ticket or start_ticket, though no sibling is named explicitly.

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?

It states the timing ('Call it before your ticket is done') and the permission scope ('assignee, PM or lead only'), and explains that calling after done rewrites the posted announcement. That is a strong when-to-call and who-can-call signal, with no explicit when-not beyond the skip flag.

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.

Resources