Skip to main content
Glama

Update Closeout Document

update_closeout_document
Destructive

Use this when working with RetailHardHat field_operations records in the connected organization. Edit closeout metadata without approval or identity overrides. 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": {
      "closeoutDocumentId": "<closeoutDocumentId>",
      "data": "<data>"
    },
    "name": "update_closeout_document"
  }
}

Input Schema

NameRequiredDescriptionDefault
dataYes
closeoutDocumentIdYes

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 declare destructiveHint=true and readOnlyHint=false, so safety is known. The description adds genuinely non-redundant behavior: the change is staged and requires human approval via execute_approved_action, approval requirements are admin-configurable, and business workflow approvals still apply. The phrase 'without approval or identity overrides' is mildly confusing against the approval requirement, but read as describing the tool's own arguments it is not a contradiction.

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?

Four sentences, none wasted exactly, but the leading sentence is boilerplate that could be cut to put 'Edit closeout metadata' first. The approval mechanics are correctly placed after the purpose.

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 described, and annotations cover the safety profile. However, for a destructive mutation with a nested 6-field payload at 0% schema coverage, the definition leaves the agent without any map of what can be changed or whether the update is a partial patch. The description is not complete enough for the tool's complexity.

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% and the tool takes a nested `data` object with six fields (title, docType enum, fileName, fileSize, expiresAt, description) plus closeoutDocumentId. The description says nothing about any of these — not which fields are updatable, not that `data` is a partial patch, not the enum values. With zero schema coverage the description was required to compensate and does not.

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 verb+resource pair is concrete: 'Edit closeout metadata' on a closeout document, which is distinguishable from sibling attach/delete/get_closeout_document. The opening sentence ('Use this when working with RetailHardHat field_operations records') is generic context that adds no differentiating information, but the second sentence anchors the purpose.

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?

It states a clear operational context and, importantly, the invocation path: no change occurs until a human approves in Settings > MCP and execute_approved_action is called. That is real when-to-use guidance an agent needs for a gated mutation. It stops short of naming a specific alternative for plain metadata reads (get_closeout_document), so not a 5.

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