Skip to main content
Glama

Read a site file

read_site_file
Read-only

Read one file from a site's draft tree (text, or base64 for binary; 512 KB cap). Returns a 'hash' of the current bytes.

Input Schema

NameRequiredDescriptionDefault
pathYes
slugYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, so the safety profile is covered; the description adds genuinely new behavioral facts: encoding switches to base64 for binary content, there is a 512 KB read cap, and the response includes a hash of the current bytes. These are the exact constraints an agent needs before deciding whether this tool can carry a file's content. It does not describe behavior for a missing path or an over-cap file.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

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

A single dense sentence with the resource up front, then encoding, size cap and return value in order of decreasing importance. No filler and nothing that restates the title.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the description carries the burden of explaining returns and does mention the hash, but it omits the overall response shape (where the content lives, how binary vs text is signaled) and never covers the two undocumented parameters. Adequate to attempt a call, not sufficient to call it confidently.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so both slug and path are bare strings with no documentation in either place. The description only gestures at their meaning through "a site's draft tree" and never clarifies whether path is absolute or relative, whether it needs a leading slash, or what a slug identifies. This is the clearest gap in the definition.

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?

"Read one file from a site's draft tree" gives a specific verb plus resource and, importantly, scopes it to a single file in the draft tree, which implicitly separates it from list_site_files, write_site_files and patch_site_file. It stops short of naming those siblings explicitly, so an agent must infer the boundary rather than read it.

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?

The description never says when to reach for this tool versus list_site_files (to discover paths) or get_site (for site metadata), nor does it state any prerequisites or failure conditions. The only contextual hint is "draft tree," which implies unreleased content but is not framed as usage guidance.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources