doc_write
Write one file under a write share, on the machine that holds it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | ||
| text | Yes | ||
| space | No | ||
| base_sha256 | No |
Write one file under a write share, on the machine that holds it.
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | ||
| text | Yes | ||
| space | No | ||
| base_sha256 | No |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=false, destructiveHint=false, idempotentHint=false and openWorldHint=true, so the safety profile is covered. The description adds only that the write targets a remote host ("the machine that holds it"); it says nothing about overwrite behavior, whether an existing file is clobbered, or what a non-idempotent re-run does.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single front-loaded sentence with no filler and no trailing caveats. It is efficient, but the brevity comes at the cost of substance rather than being trim prose around a complete statement.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a mutation tool with four parameters, 0% schema coverage, and no output schema, the description omits the two parameters that determine correct invocation (space, base_sha256) and gives no return signal. The remote-host detail is helpful but far short of what this tool's complexity demands.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 0% across four parameters, so the description carries the full burden and provides nothing: neither `space` (which share namespace) nor `base_sha256` (evidently an optimistic-concurrency precondition token) is named or explained. An agent cannot know from the definition that base_sha256 guards against clobbering a concurrently modified file.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description names a specific verb and resource ("write one file") plus its scope ("under a write share") and the execution locus ("the machine that holds it"). An agent can distinguish this from doc_read or doc_list by name, though the description never explicitly contrasts them.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no statement of when to use this versus doc_read/doc_share, no prerequisites (write permissions, space selection), and no when-not guidance. The only implied usage is the phrase "under a write share," which is left for the agent to decode.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.