Skip to main content
Glama

Write Text File

write_file
DestructiveIdempotent

Creates or overwrites a text file within an allowed directory, letting you save content to a specified path for Java project file generation and updates.

Instructions

Create or overwrite a text file inside an allowed directory.

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": {
      "path": "<path>",
      "content": "<content>"
    },
    "name": "write_file"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYesFile path to write
contentYesContent to write

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.1

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare destructiveHint=true, idempotentHint=true, and readOnlyHint=false, so the safety profile is covered. The description corroborates with 'overwrite' and adds the directory restriction, but says nothing about error behavior, whether parent directories are created, encoding, or permissions.

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 short sentence with the operation and constraint front-loaded; every word earns its place and nothing is padded.

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

Completeness4/5

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

For a simple two-parameter write with full schema coverage and rich annotations, the definition covers what the tool does and where it may operate. Only edge-case behavior on overwrite or failure is left unspecified, which is a minor gap given the annotation coverage.

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 both 'path' and 'content' are already documented; the baseline is 3. The description adds only the mild constraint that the path must lie inside an allowed directory, with no format or validation details beyond that.

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 pair ('Create or overwrite') and resource ('a text file'), plus a scoping constraint ('inside an allowed directory'). It does not distinguish itself from siblings like read_text_file or backup_file, but the operation is unambiguous.

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 'allowed directory' constraint implies where it may be used, but there is no explicit when-to-use guidance, no mention of backing up before overwriting an existing file, and no routing to siblings such as backup_file or delete_file.

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