Skip to main content
Glama

List Permit Documents

list_permit_documents
Read-onlyIdempotent

Use this when working with RetailHardHat documents records in the connected organization. Read permit document metadata. 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": {
      "permitId": "<permitId>"
    },
    "name": "list_permit_documents"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNo
offsetNo
searchNo
permitIdYes

Output Schema

NameRequiredDescriptionDefault
dataYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

C2.8/5.0
Behavior3/5

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

The annotations already declare readOnlyHint, idempotentHint, non-destructive, and closed-world, so the safety profile is covered. The description adds one piece of genuine behavioral context: MCP approval requirements are administrator-configurable while business workflow approvals always apply. That is useful but abstract — it does not say whether this specific read call ever blocks on approval, nor does it mention pagination or result caps, which matter for a list tool.

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?

Only one of the three sentences does real work ("Read permit document metadata"); the opening clause is awkward filler ("documents records") and the approval sentence is generic boilerplate repeated across the tool family. It is short, but the useful content is not front-loaded.

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

Completeness2/5

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

An output schema exists, so return values need not be explained, and annotations cover safety. But with 0% schema coverage on four parameters and no mention of pagination, filtering, or the approval behavior specific to this call, the description leaves an agent under-equipped to invoke it correctly.

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% across four parameters, so the description must carry the burden — and it says nothing about permitId, limit, offset, or search. An agent cannot learn from the text that results are paginated with a default page size of 50, or that 'search' filters metadata within a permit.

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 second sentence, "Read permit document metadata," gives a specific verb and resource and implicitly distinguishes this list operation from read_permit_document (which fetches content) and from list_permits. However, the surrounding boilerplate ("working with RetailHardHat documents records in the connected organization") is generic and does not name any of the many sibling document-list tools.

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 only usage cue is the vague "Use this when working with RetailHardHat documents records," which would apply equally to dozens of document tools in the sibling list. It never states when to choose this over read_permit_document, list_project_documents, list_site_documents, or list_permits, nor does it give prerequisites such as needing an existing permit.

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