Skip to main content
Glama

update_doc

Replace or append a document in memory to keep scoped agent context and session handoffs current.

Instructions

Replace or append a doc in memory.

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": {
      "doc": "<doc>",
      "body": "<body>"
    },
    "name": "update_doc"
  }
}

Input Schema

NameRequiredDescriptionDefault
docYes
bodyYes
modeNo
session_idNosession_id returned by start_session. If missing/expired, call start_session and follow next_action before retrying.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.3.3

TDQS

C2.7/5.0
Behavior2/5

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

With no annotations, the description carries the full behavioral burden. It implies a mutation and hints that replace overwrites while append adds, but says nothing about session requirements, reversibility, failure behavior, or what happens to prior content in replace mode.

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?

A single front-loaded sentence with no wasted words. It is efficient, though its brevity contributes to the specification gaps elsewhere.

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 no annotations and no output schema, the definition is too thin. An agent still lacks doc identity semantics, mode-selection guidance, and session/auth behavior beyond what the session_id schema note provides.

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 only 25%, and only session_id is documented in the schema. The description does not explain what 'doc' refers to (name, path, ID) or clarify body semantics, so it fails to compensate for the coverage gap.

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 states a specific verb pair and resource: replace/append a doc in memory. That is enough to distinguish it from read-side siblings such as get_doc, though it never explains what a 'doc' is in this system.

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 guidance on when to choose update_doc over update_context or update_skill, and no explanation of when replace versus append is appropriate. The mode enum is left entirely to inference.

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