Skip to main content
Glama

Write a text file

write_file
Idempotent

Create or overwrite text files in Overleaf projects, automatically preserving previous versions in history.

Instructions

Create or overwrite a text document in an Overleaf project. Overwriting records a new version in Overleaf history.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYes
contentYes
projectIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false and idempotentHint=true, and the description adds meaningful context by noting that overwriting records a new version in Overleaf history, which explains the non-destructive nature consistent with destructiveHint=false. This goes beyond the annotations and clarifies the overwrite behavior.

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?

Two sentences, front-loaded with the core action, and every sentence adds value. No fluff or redundant information.

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 write operation with 3 parameters and no output schema, the description covers the essential behavior (create/overwrite) and the versioning side effect. It does not mention error conditions or prerequisites, but these are minor given the tool's simplicity and the sibling context.

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?

The schema description coverage is 0%, so the description should compensate by explaining the parameters. However, it only mentions 'text document' and 'Overleaf project' without detailing path, content, or projectId semantics. The parameter names are self-explanatory but the description does not clarify expected formats or relationships (e.g., whether path includes directories).

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?

The description states a clear verb ('Create or overwrite') and resource ('text document in an Overleaf project'), and distinguishes itself from siblings like read_file and upload_file by specifying text content and versioning behavior. This is a specific and unambiguous purpose.

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 description implies usage for text files and mentions overwriting with version history, but it does not explicitly state when to prefer this tool over siblings such as upload_file (which likely handles binary files) or when not to use it. There is no explicit exclusion or alternative guidance.

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