Skip to main content
Glama

Attach Permit Document

attach_permit_document

Use this when working with RetailHardHat documents records in the connected organization. Attach an uploaded file owned by this organization to a permit. No change occurs until a human approves the exact request in Settings > MCP and execute_approved_action is called. 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>",
      "data": "<data>"
    },
    "name": "attach_permit_document"
  }
}

Input Schema

NameRequiredDescriptionDefault
dataYes
permitIdYes

Output Schema

NameRequiredDescriptionDefault
dataYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.4/5.0
Behavior4/5

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

Annotations already establish mutation semantics (readOnlyHint=false, destructiveHint=false, idempotentHint=false), so the bar is lower. The description goes beyond them by disclosing the two-stage approval flow, the Settings > MCP approval surface, configurable admin requirements, and that business workflow approvals always apply. It does not mention what happens on a duplicate attach or an invalid/foreign fileUrl, which matters given idempotentHint=false.

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 core action is buried in the second sentence behind a boilerplate opener. The approval-policy sentences carry genuine information but are verbose, and the repeated framing about organization-configurable requirements could be compressed to one clause without losing meaning.

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, so return values needn't be explained, and the mutation/approval semantics—the riskiest part of this tool—are well covered. What's missing is the prerequisite chain (upload first via request_file_upload) and any hint about choosing a documentType, which leaves the agent under-informed for a nested two-parameter write.

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 a nested object with five subfields, so the description must compensate and largely does not. The phrase 'uploaded file owned by this organization' hints that fileUrl must reference an org-owned upload, but permitId, the documentType enum values, name/notes limits, and the fileUrl regex are all left to the schema alone.

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 states a specific verb and resource: attach an uploaded file to a permit. That's enough to distinguish it from list_permit_documents or read_permit_document. The opening sentence ('Use this when working with RetailHardHat documents records in the connected organization') is vague filler and adds nothing, and the description doesn't contrast this tool with the many sibling attach_* tools (attach_bid_document, attach_project_document, etc.).

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?

It describes the approval precondition clearly (no change until a human approves the exact request and execute_approved_action is called), which is real when-to-use context. However, it never says how to obtain the fileUrl (the sibling request_file_upload exists for this), and gives no when-not guidance or alternative for attaching to a different record type. Usage is implied rather than 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