doc_read
Read one shared file live (text up to 256 KiB; binary files report size and sha256).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | ||
| space | No |
Read one shared file live (text up to 256 KiB; binary files report size and sha256).
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | ||
| space | No |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already cover read-only/idempotent/safe, so the bar is lower, and the description still adds real behavior beyond them: a 256 KiB text ceiling and the fact that binary files return size and sha256 instead of content. It doesn't say what happens to text files larger than 256 KiB (truncation vs error), which is the one remaining behavioral question.
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?
One sentence, front-loaded with the action and scope, with the size limit and binary-file behavior packed into parenthetical clauses. Nothing is wasted.
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?
With no output schema, the description does a good job sketching the binary return shape but leaves the text return shape, the over-limit behavior, and the 'space' parameter undocumented. Adequate for a simple read, but an agent could still mis-call it on a large or ambiguous file.
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% and the description says nothing about either parameter. In particular 'space' is unexplained — an agent cannot tell whether it is a namespace, a required scope for shared files, or an optional override — so the description fails to compensate for the schema gap.
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?
States a specific verb and resource ('Read one shared file live'), which is unambiguous against doc_write, doc_share, and doc_list. It stops short of explicitly contrasting with the closest sibling (doc_list) but the single-file scope is implied by 'one'.
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?
No guidance on when to use this vs doc_list or space_read, and no note on prerequisites such as needing a share grant before a file is readable. The agent must infer usage entirely from the tool name.
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.