Skip to main content
Glama

propose_revision

Propose a corrected revision of a knowledge entry using optimistic concurrency, requiring the expected revision to prevent conflicting updates.

Instructions

Propose a correction using optimistic concurrency.

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": {
      "entry_id": "<entry_id>",
      "expected_revision": "<expected_revision>",
      "entry": "<entry>"
    },
    "name": "propose_revision"
  }
}

Input Schema

NameRequiredDescriptionDefault
entryYes
entry_idYes
actor_handleNo
idempotency_keyNo
expected_revisionYes

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.4/5.0
Behavior2/5

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

No annotations are supplied, so the description carries the full burden, and it only hints at behavior via the phrase 'optimistic concurrency'. It does not say what happens when expected_revision is stale (error? retry? overwrite?), whether the proposal lands in a candidate or published lifecycle state, whether an actor or idempotency key is required, or that a conflict aborts the write. For a mutation tool with zero annotation coverage this is a substantial gap.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

It is a single front-loaded sentence with no filler, which is structurally clean. But the brevity crosses into under-specification for a tool with a deeply structured payload and concurrency semantics, so the sentence does not earn its place as sufficient documentation.

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?

The input schema is large and complex (nested EntryPayload with many optional fields, SourceRef, EvidenceRef, ProvenanceRef), yet the description says nothing about what a revision payload should contain or how it differs from an original entry. An output schema exists so return values need not be described, but the conflict-handling behavior and payload expectations remain undocumented.

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?

Top-level schema description coverage is 0%, and the description explains none of the five parameters. 'Optimistic concurrency' weakly implies that expected_revision must match the entry's current revision, but entry_id, the large EntryPayload object, actor_handle, and idempotency_key receive no semantic guidance in the description. The nested $defs descriptions do some of this work, but not the description itself.

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 verb 'propose' plus the object 'a correction' indicates a write that suggests a change rather than applying one directly, which is a meaningful distinction from a plain 'record'. However, 'correction' is never tied to the actual resource (a new revision of an existing entry keyed by entry_id), so an agent must infer from the tool name alone that this operates on existing entries rather than creating new ones. No sibling tool is named or contrasted.

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

Usage Guidelines2/5

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

There is no statement of when to use this tool versus alternatives such as record, submit_review, or review_next. Nothing indicates prerequisites (e.g. that the target entry must already exist), nor when-not to use it. The only implied usage comes from the word 'correction'.

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