Skip to main content
Glama

Update Site Document

update_site_document
Destructive

Use this when working with RetailHardHat documents records in the connected organization. Edit site document metadata; cannot replace its storage identity. 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": {
      "siteId": "<siteId>",
      "documentId": "<documentId>",
      "data": "<data>"
    },
    "name": "update_site_document"
  }
}

Input Schema

NameRequiredDescriptionDefault
dataYes
siteIdYes
documentIdYes

Output Schema

NameRequiredDescriptionDefault
dataYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true and idempotentHint=false; the description adds genuinely new context by disclosing that the mutation is approval-gated through execute_approved_action and that storage identity is immutable. It does not clarify whether unspecified metadata fields are cleared (PATCH vs replace semantics), which matters for a destructive nested-object update.

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 operative constraint ('Edit site document metadata; cannot replace its storage identity') is buried behind an opening sentence of pure filler ('Use this when working with RetailHardHat documents records...'). The approval boilerplate is load-bearing and earns its place, but the lead sentence does not.

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?

Return values need no explanation given the output schema, and the approval/immutability facts cover the risk profile. For a destructive tool with a nested editable object and 0% schema coverage, though, the description should indicate which metadata fields are updatable and what happens to fields left out of data.

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%: siteId, documentId, and the nested data object (name, fileSize, fileType, folderId, description) carry no documented meaning in the schema. The description only obliquely constrains this territory with 'cannot replace its storage identity', leaving the agent to guess which fields are editable, what null means for fileSize/fileType, and whether folderId here duplicates move_site_document.

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 states a specific verb and resource ('Edit site document metadata') and adds a scope constraint ('cannot replace its storage identity'), which separates it from delete_site_document or move_site_document. It stops short of naming the near-identical siblings (update_project_document, update_task_document, update_closeout_document), so an agent must infer 'site' scoping from the name alone.

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 approval workflow is spelled out concretely: no change occurs until a human approves in Settings > MCP and execute_approved_action is called. That is real when-to-use guidance for a gated mutation. It does not, however, say when to prefer this over the parallel document-update tools or over move_site_document for folder changes.

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