Skip to main content
Glama
yashisrani
by yashisrani

save_document

Write generated Markdown documentation directly to a local file path, creating READMEs, guides, or contributing docs and optionally overwriting existing files.

Instructions

Write the generated documentation directly to a file on the local filesystem (e.g. README.md, docs/quickstart.md, CONTRIBUTING.md).

Input Schema

NameRequiredDescriptionDefault
contentYesThe complete markdown documentation content to save
file_pathYesRelative or absolute destination file path (e.g. 'README.md' or 'docs/api-guide.md')
overwriteNoWhether to overwrite if the file already exists. Defaults to false.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A3.5/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 for a filesystem-writing tool. It discloses the destination domain (local filesystem) but says nothing about side effects: whether parent directories are created, what happens when the file exists without overwrite, whether existing content is lost, or what the call returns on success/failure.

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

Conciseness5/5

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

A single sentence with the verb and scope front-loaded and zero filler. Nothing needs trimming and nothing is buried.

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

Completeness3/5

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

For a 3-parameter mutation tool with full schema coverage but no annotations and no output schema, the description covers what the tool does but not what it returns or how failures surface. Adequate to invoke, incomplete for predicting behavior.

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 description coverage is 100%, so all three parameters—including the overwrite default—are already documented in the schema. The description's example paths (README.md, docs/quickstart.md) merely duplicate the file_path schema text rather than adding new semantics.

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 (Write) plus resource (generated documentation) and destination (a file on the local filesystem), with concrete example targets (README.md, docs/quickstart.md). No sibling in the list writes files—the others are template/style/skeleton readers and generators—so an agent can route here unambiguously.

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?

The phrase 'the generated documentation' implies this is the step after generating content, but the description never states when to use this versus generate_document_skeleton or when not to call it. Usage is inferable but not spelled out.

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