Skip to main content
Glama

notice_publish

Announce changes other files must react to—renames, moves, removals, signature or behavior shifts—with affected paths. Affected agents get the notice at once; others see it in their next claim.

Instructions

Announce a change other files must react to: a rename, signature change, removal, move or behavior change, with from, to and the affected_paths. Use after changing something used outside the paths you claimed; not for interface shapes, which contract_publish versions and announces itself. Every other agent holding an affected path gets it in its inbox at once, and the rest see it in the brief of their next claim there.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
toNoThe new name, location, or shape.
fromNoThe old name, location, or shape.
kindYesOne of `rename`, `signature`, `removed`, `moved`, `behavior`.
agentYesYour stable agent name.
summaryYesOne-line summary, for example `renamed session_id to token`.
contract_idNoRelated contract id, if any.
affected_pathsYesPaths whose code must react.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
noticeNoid, kind, summary, from, to, affected_paths, contract_id, published_by, published_at.
statusYesok. not_found: an unknown contract_id. invalid: bad kind or input.
messageNoHuman-readable detail, on most outcomes other than ok.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed9 schema fields changedv1.1.2
    • addedInput schema / properties / affected_paths / description
      Added value: +"Paths whose code must react."
    • addedInput schema / properties / agent / description
      Added value: +"Your stable agent name."
    • addedInput schema / properties / contract_id / description
      Added value: +"Related contract id, if any."
    • addedInput schema / properties / from / description
      Added value: +"The old name, location, or shape."
    • addedInput schema / properties / kind / description
      Added value: +"One of `rename`, `signature`, `removed`, `moved`, `behavior`."
    • addedInput schema / properties / kind / enum
      Added value: +[
      +  "rename",
      +  "signature",
      +  "removed",
      +  "moved",
      +  "behavior"
      +]
    • addedInput schema / properties / summary / description
      Added value: +"One-line summary, for example `renamed session_id to token`."
    • addedInput schema / properties / to / description
      Added value: +"The new name, location, or shape."
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "description": "Any result may also carry lost, inbox, inbox_more and persist_error; see guide.",
      +  "properties": {
      +    "message": {
      +      "description": "Human-readable detail, on most outcomes other than ok.",
      +      "type": "string"
      +    },
      +    "notice": {
      +      "description": "id, kind, summary, from, to, affected_paths, contract_id, published_by, published_at.",
      +      "type": "object"
      +    },
      +    "status": {
      +      "description": "ok. not_found: an unknown contract_id. invalid: bad kind or input.",
      +      "enum": [
      +        "ok",
      +        "conflict",
      +        "not_found",
      +        "none",
      +        "invalid",
      +        "cancelled"
      +      ],
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "status"
      +  ],
      +  "type": "object"
      +}
  2. First observedv1.1.1

TDQS

A4.5/5.0
Behavior4/5

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

With only destructiveHint=false in the annotations, the description carries most of the behavioral disclosure burden. It reveals the side effects: 'Every other agent holding an affected path gets it in its inbox at once' and the rest see it in the brief of their next claim. This lets an agent anticipate the reach of publishing a notice.

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?

Three sentences with the purpose first, usage second, and consequence third; no filler or repetition. The longer third sentence earns its place by describing the delivery mechanism.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 7-parameter tool with 4 required parameters, an output schema exists and every parameter is documented in the schema. The description supplies the remaining usage rule and behavioral consequences, so nothing essential seems missing for correct invocation.

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 the structured fields already define kind, from/to, and affected_paths. The description only renames these ('with from, to and the affected_paths') and does not add format, edge-case, or constraint details beyond 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 object: 'Announce a change other files must react to' and enumerates concrete change kinds ('rename, signature change, removal, move or behavior change'). It also explicitly distances itself from interface-shape changes, which are 'contract_publish' territory, so it is distinguishable from its sibling tools.

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

Usage Guidelines5/5

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

It states exactly when to use it: 'Use after changing something used outside the paths you claimed.' It also gives a clear exclusion: 'not for interface shapes, which contract_publish versions and announces itself,' pointing to the alternative sibling.

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