Read a site file
read_site_fileRead one file from a site's draft tree (text, or base64 for binary; 512 KB cap).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | ||
| slug | Yes |
read_site_fileRead one file from a site's draft tree (text, or base64 for binary; 512 KB cap).
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | ||
| slug | Yes |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already provide readOnlyHint=true, and the description adds meaningful behavior: text vs base64 for binary and a 512 KB cap. It does not cover missing-file behavior, but the safety profile is already covered by annotations.
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. Every clause adds necessary information: what is read, where from, encoding behavior, and the size cap.
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 two-parameter read tool with a readOnly annotation, the description covers the key operational details: target tree, encoding, and size limit. Missing path-format specifics are a minor gap given the tool's simplicity.
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 does not define 'slug' or 'path' beyond property names. It leaves the path format and exact meaning of slug to inference, so it fails to compensate for the low schema coverage.
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 file from a site's draft tree.' It clearly distinguishes itself from siblings like list_site_files and write_site_files by specifying a single-file read.
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?
The description implies when to use the tool (reading one file) but does not explicitly name alternatives or exclusions, such as using list_site_files to discover paths or write_site_files to modify files.
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.