Skip to main content
Glama

ds_write_file

Write Base64-encoded content to an iRODS data-object at a specified path and offset. Use this to update large files in chunks; access oversized files via WebDAV URI.

Instructions

Write the partial content to a file (data-object) with the specified path and offset. The specified path must be an iRODS path. If the file is too large to be displayed inline, use the WebDAV URI to access it.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesThe path to the file (data-object) to write to.
offsetNoThe offset to start writing the file from. Default is 0.
contentYesThe Base64-encoded content to write to the file (data-object). Maximum size is 1048576 bytes.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.8/5.0
Behavior2/5

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

No annotations are provided, so the description must carry the full behavioral burden. It does not disclose whether writing overwrites existing content, whether the file must already exist, what permissions are required, or what errors can occur. The max size and iRODS path constraint are mentioned but are not enough 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.

Conciseness3/5

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

The core action is front-loaded in the first sentence, which is good. However, the third sentence about displaying large files and WebDAV URIs is irrelevant to a write operation and adds confusion rather than value.

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 write tool with no annotations and no output schema, the description leaves critical gaps: it does not explain overwrite semantics, required permissions, or return behavior. It is not complete enough for an agent to invoke confidently in varied scenarios.

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 the schema already documents all three parameters. The description adds only that the path must be an iRODS path, which is a minor constraint beyond the schema text. Baseline 3 is appropriate.

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 ('Write') and resource ('partial content to a file (data-object)') with path and offset. It does not distinguish itself from likely siblings like ds_upload_file or clarify how partial writes differ from full uploads, so it falls short of a 5.

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?

No guidance on when to use this tool versus alternatives such as ds_upload_file or ds_read_file. The third sentence about WebDAV URI for large files is about reading, not writing, and does not help select this tool.

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