Skip to main content
Glama

Read Permit Document

read_permit_document
Read-onlyIdempotent

Use this when working with RetailHardHat documents records in the connected organization. Read authorized permit 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_permit_document"
  }
}

Input Schema

NameRequiredDescriptionDefault
documentIdYes

Output Schema

NameRequiredDescriptionDefault
dataYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, so the bar is lower, yet the description adds real behavioral context: output is raw base64 or UTF-8 text, there is a hard 2 MiB ceiling, access is limited to 'authorized' files, and approvals may be required depending on admin configuration. What it omits is what happens at the size limit (error vs. truncation).

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

Conciseness3/5

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

The substantive content (encoding, size cap, approval caveat) is compact and useful, but it is preceded by a filler sentence ('Use this when working with RetailHardHat documents records...') that reads as template boilerplate and pushes the useful constraints behind it. Front-loading the read behavior would be better.

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

Completeness4/5

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

An output schema exists, and the description still helpfully states the payload encoding and size limit, so an agent knows roughly what it gets back. For a single-parameter read tool this is nearly complete; only the failure mode at the 2 MiB boundary and the id-discovery path are missing.

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% for the single documentId parameter, so the description carries the burden and only partially meets it: it implies the id refers to an authorized permit file but never says how to obtain a valid id (e.g. via list_permit_documents) or that it is a UUID. Baseline 3 for a one-parameter tool with limited added semantics.

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 description uses a specific verb ('Read') on a specific resource ('authorized permit file bytes') and even states the returned encoding (base64 or UTF-8). It is not tautological, but it never explicitly distinguishes itself from the many sibling readers like read_site_document or read_project_document, so the sibling differentiation must be inferred from the tool name.

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

Usage Guidelines3/5

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

The opening clause 'Use this when working with RetailHardHat documents records in the connected organization' is broad context rather than a when-to-use rule, and no alternative (e.g. list_permit_documents to obtain an id, or read_site_document for other document types) is named. Usage is implied by the tool name and the word 'permit', not stated.

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