Skip to main content
Glama

update

Edit an initiative's front-matter fields or H1, or replace a named body section to refine tickets, including done work, without changing status.

Instructions

Edit an initiative's (ticket's/issue's) front-matter fields or H1, or replace a named body section — including on a done initiative, which is how settled work is refined (no status change needed). status records the status an initiative already has when its front-matter has none (no lifecycle checks); to change a recorded status, use set_status. Cannot change its number or filename. A milestone this reaches, or stops being reached, is reported under milestones.

Input Schema

NameRequiredDescriptionDefault
refYesInitiative (ticket/issue): "collection#n" (e.g. "lgm#22"), a bare number, or a path.
docsNo
tagsNo
typeNo
ownerNo
titleNo
reasonNoWith `status`: why it was abandoned, superseded or deferred, if known.
statusNoRecord the status this initiative already has, when its front-matter has none (e.g. backfilling an adopted folder). Refused if a status is recorded: use set_status.
contentNoThe section's body, without its heading (a leading heading naming the section is dropped).
sectionNoName of the "## " section to replace, or add if missing.
collectionNo
dimensionsNoScoring dimension values to set, e.g. { "priority": "high" }; each must be one of the dimension's values. null clears one.
status_noteNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changedv2.6.0
    • addedInput schema / properties / content / description
      Added value: +"The section's body, without its heading (a leading heading naming the section is dropped)."
    • addedInput schema / properties / dimensions
      Added value: +{
      +  "additionalProperties": {
      +    "type": [
      +      "string",
      +      "number",
      +      "null"
      +    ]
      +  },
      +  "description": "Scoring dimension values to set, e.g. { \"priority\": \"high\" }; each must be one of the dimension's values. null clears one.",
      +  "propertyNames": {
      +    "type": "string"
      +  },
      +  "type": "object"
      +}
    • addedInput schema / properties / reason
      Added value: +{
      +  "description": "With `status`: why it was abandoned, superseded or deferred, if known.",
      +  "type": "string"
      +}
    • changedInput schema / properties / ref / description
      Previous value: -"Initiative: \"collection#n\", a bare number, or a path."New value: +"Initiative (ticket/issue): \"collection#n\" (e.g. \"lgm#22\"), a bare number, or a path."
    • addedInput schema / properties / section / description
      Added value: +"Name of the \"## \" section to replace, or add if missing."
    • addedInput schema / properties / status
      Added value: +{
      +  "description": "Record the status this initiative already has, when its front-matter has none (e.g. backfilling an adopted folder). Refused if a status is recorded: use set_status.",
      +  "type": "string"
      +}
  2. First observedv0.1.0

TDQS

A4.3/5.0
Behavior4/5

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

No annotations are present, so the description carries the full burden, and it does disclose meaningful traits: no lifecycle checks, the 'refused if a status is recorded' rule, the H1 replacement and leading-heading-drop behavior, and the milestone reporting side-effect. It stops short of stating permission/auth requirements or reversibility, so it is strong but not exhaustive.

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?

Dense but mostly earned: the core action is front-loaded and each clause adds a real constraint (status recording, set_status alternative, number/filename immutability, milestone reporting). Slightly heavy with backtick asides, keeping it below a clean 5.

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 13-parameter mutation tool with no annotations and no output schema, the description covers the highest-risk ambiguities (status vs. set_status, immutability, milestone side-effects) and needs no return-value explanation since output is absent. Leftover gaps are the undocumented front-matter params, which keeps it from a 5.

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 46%, so several parameters (docs, tags, type, owner, title, collection, status_note) are undocumented in both schema and description. The description clarifies the tricky `status` semantics and the section/content behavior, which is useful, but it does not compensate for the remaining coverage gap, so the baseline holds.

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 (edit) and precise resources: an initiative's front-matter fields, H1, or a named body section. It explicitly contrasts with the set_status sibling and names what cannot be changed (number, filename), so the agent can distinguish it from siblings without opening the schema.

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?

Gives explicit when-to-use (edit fields, refine done work with no status change) and names the alternative condition ('to change a recorded status, use set_status'). The overlap with set_status is resolved directly in the text.

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