Retrieve the contents of a text file from the exposed directory using its relative path. Enables agents to access file data for analysis or processing.
Read one text file from the exposed directory.
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | File path relative to the exposed root. |
Changes observed during successful MCP inspections.
v0.1.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the full burden. It states the action but does not disclose behavior for missing paths, non-text files, permissions errors, or whether the operation is strictly read-only beyond the verb itself.
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?
The description is a single concise sentence that directly states the tool's purpose without unnecessary words or repetition.
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 simple read operation, the description provides sufficient context. It does not explicitly describe the return value, but the output schema is absent and the purpose strongly implies file content is returned.
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?
The single parameter path is fully described in the schema as 'File path relative to the exposed root.' The tool description adds no extra semantic detail, but schema coverage is 100%, so the baseline of 3 is appropriate.
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 clearly identifies the action ('Read'), the resource ('one text file'), and the scope ('from the exposed directory'). It is distinguishable from sibling tools like list_files and search, though it does not explicitly name 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?
Usage is implied by the verb 'Read' and the singular 'one text file', contrasting with listing or searching, but no explicit guidance is given about when to prefer this tool over siblings or when not to use it.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.