Skip to main content
Glama

revise

Update an existing memory record while preserving its identity and tier; omitted fields remain unchanged, and immutable source bytes can be replaced.

Instructions

Patch the same record, preserving identity and tier. Omitted fields remain unchanged; immutable source bytes are replaced through replace.

Input Schema

NameRequiredDescriptionDefault
nodeYes
patchYes
initiativeYes
request_idNoOptional stable operation key supplied by the host/SDK; see replay contract.
expected_revisionNoOpaque revision of the primary target, as returned by reads.

Output Schema

NameRequiredDescriptionDefault
dataYes
stateYes
issuesYes
coverageNo
replayedYes
operationYes
request_idNo
api_versionYes
continuationNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed15 schema fields changedv0.8.0
    • addedInput schema / $defs
      Added value: +{
      +  "Applicability": {
      +    "additionalProperties": false,
      +    "minProperties": 1,
      +    "properties": {
      +      "task": {
      +        "$ref": "#/$defs/NodeRef"
      +      },
      +      "through": {
      +        "format": "date",
      +        "type": "string"
      +      }
      +    },
      +    "required": [],
      +    "type": "object"
      +  },
      +  "NodeRef": {
      +    "oneOf": [
      +      {
      +        "description": "Returned UUID or exact name in the call initiative; ambiguity is an error.",
      +        "minLength": 1,
      +        "type": "string"
      +      },
      +      {
      +        "additionalProperties": false,
      +        "properties": {
      +          "id": {
      +            "description": "Returned canonical ID, including IDs from older vaults.",
      +            "minLength": 1,
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "id"
      +        ],
      +        "type": "object"
      +      },
      +      {
      +        "additionalProperties": false,
      +        "properties": {
      +          "initiative": {
      +            "minLength": 1,
      +            "type": "string"
      +          },
      +          "name": {
      +            "minLength": 1,
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "name",
      +          "initiative"
      +        ],
      +        "type": "object"
      +      }
      +    ]
      +  },
      +  "Patch": {
      +    "additionalProperties": false,
      +    "minProperties": 1,
      +    "properties": {
      +      "applicability": {
      +        "anyOf": [
      +          {
      +            "$ref": "#/$defs/Applicability"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "body": {
      +        "type": "string"
      +      },
      +      "constraint_state": {
      +        "enum": [
      +          "active",
      +          "released"
      +        ],
      +        "type": "string"
      +      },
      +      "description": {
      +        "type": "string"
      +      },
      +      "name": {
      +        "minLength": 1,
      +        "type": "string"
      +      },
      +      "reminder": {
      +        "anyOf": [
      +          {
      +            "$ref": "#/$defs/Reminder"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      }
      +    },
      +    "required": [],
      +    "type": "object"
      +  },
      +  "Reminder": {
      +    "additionalProperties": false,
      +    "properties": {
      +      "after": {
      +        "format": "date",
      +        "type": "string"
      +      },
      +      "window_days": {
      +        "maximum": 2147483647,
      +        "minimum": 1,
      +        "type": "integer"
      +      }
      +    },
      +    "required": [
      +      "after",
      +      "window_days"
      +    ],
      +    "type": "object"
      +  }
      +}
    • addedInput schema / additionalProperties
      Added value: +false
    • removedInput schema / properties / body
      Removed value: -{
      -  "default": null,
      -  "description": "New body. If omitted, keeps current.",
      -  "type": [
      -    "string",
      -    "null"
      -  ]
      -}
    • addedInput schema / properties / expected_revision
      Added value: +{
      +  "description": "Opaque revision of the primary target, as returned by reads.",
      +  "minLength": 1,
      +  "type": "string"
      +}
    • removedInput schema / properties / initiative / default
      Removed value: -null
    • addedInput schema / properties / initiative / minLength
      Added value: +1
    • changedInput schema / properties / initiative / type
      Previous value: -[
      -  "string",
      -  "null"
      -]New value: +"string"
    • removedInput schema / properties / name
      Removed value: -{
      -  "description": "Node name.",
      -  "type": "string"
      -}
    • addedInput schema / properties / node
      Added value: +{
      +  "$ref": "#/$defs/NodeRef"
      +}
    • addedInput schema / properties / patch
      Added value: +{
      +  "$ref": "#/$defs/Patch"
      +}
    • removedInput schema / properties / rename
      Removed value: -{
      -  "default": null,
      -  "description": "New name. If omitted, keeps current.",
      -  "type": [
      -    "string",
      -    "null"
      -  ]
      -}
    • addedInput schema / properties / request_id
      Added value: +{
      +  "description": "Optional stable operation key supplied by the host/SDK; see replay contract.",
      +  "minLength": 1,
      +  "type": "string"
      +}
    • changedInput schema / required
      Previous value: -[
      -  "name"
      -]New value: +[
      +  "initiative",
      +  "node",
      +  "patch"
      +]
    • removedInput schema / title
      Removed value: -"ReviseParams"
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$defs": {
      +    "AmgOmission": {
      +      "additionalProperties": false,
      +      "properties": {
      +        "count": {
      +          "format": "uint",
      +          "minimum": 0,
      +          "type": "integer"
      +        },
      +        "reason": {
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "reason",
      +        "count"
      +      ],
      +      "type": "object"
      +    },
      +    "ArchiveFormat": {
      +      "enum": [
      +        "markdown",
      +        "amg"
      +      ],
      +      "type": "string"
      +    },
      +    "Artifact": {
      +      "properties": {
      +        "bytes": {
      +          "format": "uint",
      +          "minimum": 0,
      +          "type": "integer"
      +        },
      +        "edges": {
      +          "format": "uint",
      +          "minimum": 0,
      +          "type": "integer"
      +        },
      +        "format": {
      +          "$ref": "#/$defs/ArchiveFormat"
      +        },
      +        "initiatives": {
      +          "items": {
      +            "type": "string"
      +          },
      +          "type": "array"
      +        },
      +        "nodes": {
      +          "format": "uint",
      +          "minimum": 0,
      +          "type": "integer"
      +        },
      +        "omissions": {
      +          "items": {
      +            "$ref": "#/$defs/AmgOmission"
      +          },
      +          "type": "array"
      +        },
      +        "path": {
      +          "type": "string"
      +        },
      +        "sha256": {
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "path",
      +        "format",
      +        "bytes",
      +        "sha256",
      +        "initiatives",
      +        "omissions",
      +        "nodes",
      +        "edges"
      +      ],
      +      "type": "object"
      +    },
      +    "Change": {
      +      "properties": {
      +        "after": true,
      +        "before": true,
      +        "field": {
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "field",
      +        "before",
      +        "after"
      +      ],
      +      "type": "object"
      +    },
      +    "Continuation": {
      +      "properties": {
      +        "cursor": {
      +          "type": "string"
      +        },
      +        "next_arguments": true
      +      },
      +      "required": [
      +        "cursor",
      +        "next_arguments"
      +      ],
      +      "type": "object"
      +    },
      +    "Coverage": {
      +      "properties": {
      +        "complete": {
      +          "type": "boolean"
      +        },
      +        "initiatives": {
      +          "items": {
      +            "type": "string"
      +          },
      +          "type": "array"
      +        },
      +        "omitted": {
      +          "items": {
      +            "$ref": "#/$defs/Omission"
      +          },
      +          "type": "array"
      +        },
      +        "rules_complete": {
      +          "type": "boolean"
      +        }
      +      },
      +      "required": [
      +        "initiatives",
      +        "complete",
      +        "rules_complete",
      +        "omitted"
      +      ],
      +      "type": "object"
      +    },
      +    "Entity": {
      +      "properties": {
      +        "id": {
      +          "type": "string"
      +        },
      +        "revision": {
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "id",
      +        "revision"
      +      ],
      +      "type": "object"
      +    },
      +    "EvidenceResult": {
      +      "properties": {
      +        "id": {
      +          "type": "string"
      +        },
      +        "relation": {
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "id",
      +        "relation"
      +      ],
      +      "type": "object"
      +    },
      +    "FailedStep": {
      +      "properties": {
      +        "code": {
      +          "type": "string"
      +        },
      +        "message": {
      +          "type": "string"
      +        },
      +        "step": {
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "step",
      +        "code",
      +        "message"
      +      ],
      +      "type": "object"
      +    },
      +    "Issue": {
      +      "properties": {
      +        "code": {
      +          "type": "string"
      +        },
      +        "field": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "message": {
      +          "type": "string"
      +        },
      +        "retryable": {
      +          "type": "boolean"
      +        }
      +      },
      +      "required": [
      +        "code",
      +        "message",
      +        "retryable"
      +      ],
      +      "type": "object"
      +    },
      +    "MutationData": {
      +      "properties": {
      +        "affected": {
      +          "items": {
      +            "$ref": "#/$defs/Entity"
      +          },
      +          "type": "array"
      +        },
      +        "artifacts": {
      +          "items": {
      +            "$ref": "#/$defs/Artifact"
      +          },
      +          "type": "array"
      +        },
      +        "changes": {
      +          "items": {
      +            "$ref": "#/$defs/Change"
      +          },
      +          "type": "array"
      +        },
      +        "created": {
      +          "items": {
      +            "$ref": "#/$defs/Entity"
      +          },
      +          "type": "array"
      +        },
      +        "evidence": {
      +          "items": {
      +            "$ref": "#/$defs/EvidenceResult"
      +          },
      +          "type": "array"
      +        },
      +        "failed_steps": {
      +          "items": {
      +            "$ref": "#/$defs/FailedStep"
      +          },
      +          "type": "array"
      +        },
      +        "primary": {
      +          "anyOf": [
      +            {
      +              "$ref": "#/$defs/Entity"
      +            },
      +            {
      +              "type": "null"
      +            }
      +          ]
      +        },
      +        "slots": {
      +          "items": {
      +            "$ref": "#/$defs/SlotChange"
      +          },
      +          "type": "array"
      +        }
      +      },
      +      "required": [
      +        "created",
      +        "affected",
      +        "changes",
      +        "evidence",
      +        "failed_steps",
      +        "slots",
      +        "artifacts"
      +      ],
      +      "type": "object"
      +    },
      +    "Omission": {
      +      "properties": {
      +        "count": {
      +          "format": "uint",
      +          "minimum": 0,
      +          "type": "integer"
      +        },
      +        "reason": {
      +          "type": "string"
      +        },
      +        "section": {
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "section",
      +        "count",
      +        "reason"
      +      ],
      +      "type": "object"
      +    },
      +    "SlotChange": {
      +      "properties": {
      +        "after": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "before": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "revision": {
      +          "type": "string"
      +        },
      +        "slot": {
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "slot",
      +        "revision"
      +      ],
      +      "type": "object"
      +    },
      +    "State": {
      +      "enum": [
      +        "ok",
      +        "applied",
      +        "unchanged",
      +        "partial",
      +        "rejected"
      +      ],
      +      "type": "string"
      +    }
      +  },
      +  "$schema": "https://json-schema.org/draft/2020-12/schema",
      +  "properties": {
      +    "api_version": {
      +      "const": 1,
      +      "format": "uint32",
      +      "minimum": 0,
      +      "type": "integer"
      +    },
      +    "continuation": {
      +      "anyOf": [
      +        {
      +          "$ref": "#/$defs/Continuation"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ]
      +    },
      +    "coverage": {
      +      "anyOf": [
      +        {
      +          "$ref": "#/$defs/Coverage"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ]
      +    },
      +    "data": {
      +      "$ref": "#/$defs/MutationData"
      +    },
      +    "issues": {
      +      "items": {
      +        "$ref": "#/$defs/Issue"
      +      },
      +      "type": "array"
      +    },
      +    "operation": {
      +      "const": "revise",
      +      "type": "string"
      +    },
      +    "replayed": {
      +      "type": "boolean"
      +    },
      +    "request_id": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "state": {
      +      "$ref": "#/$defs/State"
      +    }
      +  },
      +  "required": [
      +    "api_version",
      +    "operation",
      +    "state",
      +    "replayed",
      +    "data",
      +    "issues"
      +  ],
      +  "title": "Response",
      +  "type": "object"
      +}
  2. First observedv0.7.5

TDQS

B3.1/5.0
Behavior4/5

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

Annotations only declare readOnlyHint=false, so the description usefully adds mutation semantics: identity and tier are preserved, omitted fields are untouched, and immutable bytes require replace. It still omits concurrency behavior (expected_revision) and failure modes when immutable bytes are patched.

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?

Two sentences, no filler, and the replace distinction is front-loaded. The terseness comes at the cost of clarity around 'the same record', but structurally it is efficient.

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

Completeness2/5

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

For a mutation tool with five parameters, nested patch fields, and only a readOnlyHint=false annotation, the description is too thin. It leaves out targeting (initiative/node), concurrency (expected_revision), and error behavior for immutable bytes, even though an output schema exists.

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

Parameters2/5

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

Schema description coverage is 40% across five parameters. The phrase about omitted fields adds meaning for the patch object, but the description never explains initiative, node, expected_revision, or request_id, so it does not compensate for the coverage gap.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description uses a specific verb ('Patch') and distinguishes itself from replace by noting immutable source bytes are handled elsewhere. However, the resource is vague ('the same record'), and it never states that the target is an initiative node. An agent can infer a partial-update operation but not the exact domain object.

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

Usage Guidelines3/5

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

It provides an implicit alternative: immutable source bytes must go through replace. That is useful routing guidance. It does not say when to prefer revise over task_update or other mutation siblings, so usage is only partially implied.

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