Skip to main content
Glama

write_doc

Save new or agent-generated notes, summaries, and content to a semantic vault so important context persists across sessions. Supports .txt, .md, and .docx files.

Instructions

Save new information or agent-generated content to a semantic vault for future retrieval. Use this only with semantic vaults, to persist important context, summaries, or notes that should be remembered across sessions. Supports .txt, .md, and .docx formats.

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": {
      "vault_name": "<vault_name>",
      "file_path": "<file_path>",
      "content": "<content>",
      "generated_by": "<generated_by>"
    },
    "name": "write_doc"
  }
}

Input Schema

NameRequiredDescriptionDefault
contentYes
file_pathYes
overwriteNo
vault_nameYes
generated_byYes

Output Schema

NameRequiredDescriptionDefault
file_pathYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.9.1

TDQS

B3.1/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full behavioral burden, yet it discloses little. It never mentions that an 'overwrite' flag exists and defaults to false, what happens when the target file already exists, whether writes are reversible, or what permissions a vault requires — all critical for a mutation tool.

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?

Three tight sentences with the action and storage target front-loaded, followed by scoping and format constraints. No filler, though the format sentence is the least essential of the three.

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?

An output schema exists so return values need not be explained, but with zero annotations, five parameters at 0% schema coverage, and a mutation that can overwrite data, the description is too thin. The overwrite default alone warrants a sentence that is missing.

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 0% across five parameters, so the description must compensate and largely does not. It hints at supported formats (.txt, .md, .docx) relevant to file_path and implies vault_name via 'semantic vaults', but content, generated_by, and overwrite are given no meaning at all.

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?

States a specific verb and resource ('Save new information or agent-generated content to a semantic vault') and adds a scoping constraint ('only with semantic vaults'). It does not explicitly distinguish itself from siblings like write_episode or write_skill, so the agent has to infer which store is the right target.

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

Usage Guidelines4/5

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

Gives clear conditions for use: persist important context, summaries, or notes that need to survive across sessions, and restricted to semantic vaults. It stops short of naming an alternative or saying when not to use it, so the routing decision against sibling writers is left implicit.

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