Skip to main content
Glama

Read Site Document

read_site_document
Read-onlyIdempotent

Use this when working with RetailHardHat documents records in the connected organization. Read authorized site file bytes as base64, or UTF-8 text for text files. Maximum 2 MiB. MCP approval requirements are configurable by the organization administrator; business workflow approvals always apply.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "documentId": "<documentId>"
    },
    "name": "read_site_document"
  }
}

Input Schema

NameRequiredDescriptionDefault
documentIdYes

Output Schema

NameRequiredDescriptionDefault
dataYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior5/5

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

The description goes beyond simple read access by disclosing specific technical behaviors (2 MiB max size, dual encoding options). Furthermore, it details critical governance requirements, stating that both MCP configurable requirements and standard business workflow approvals always apply, adding substantial non-structural behavioral context.

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

Conciseness4/5

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

The structure is logical: Scope -> Technical Constraints -> Governance. While the opening phrase is slightly verbose, the core information is front-loaded, making it easy to scan.

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

Completeness5/5

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

Given the lack of an explicit output schema to detail the return value structure, the description is highly complete by specifying the output format (base64/UTF-8) and the constraints on the resource (2 MiB limit). It provides a complete operational picture.

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

Parameters3/5

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

Schema description coverage is 0%, so the description must carry the full burden. While it doesn't semantically describe `documentId`, it provides crucial context about the nature of the document being accessed (a 'site file'), which is necessary given the lack of structured parameter details.

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?

The tool clearly describes its action (Read file bytes/text) and the resource (RetailHardHat documents records). However, it doesn't explicitly state its scope relative to other document reading siblings like `read_project_document`, which would have made it a 5.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides strong operational boundaries, specifying file size limits (2 MiB) and output format (base64/UTF-8). It also sets clear expectations regarding organizational workflows and approvals, defining the required operational context.

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