Skip to main content
Glama

Update document party

update-document-party
Destructive

Edit the details of a party on a document.

Use this tool when:

  • A party's reference, entity type, entity name, address, or scope needs to change on an existing document

document_uuid and party_identifier (a ref_uuid, reference, or entity_name of a party on the document) are required to identify the party. All other arguments are optional and only need to be sent if their value should change. For parties linked to an account party, only party_reference can be changed — attempting to update other fields will fail.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
party_scopeNoNew scope. Cannot be set when the party's is_internal is true
document_uuidYesUUID of the document containing the party to update. If you don't already have the document's UUID, use the list-documents tool to find it.
party_addressNoNew address. Cannot be set when the party's is_internal is true
party_referenceNoNew generic reference for the party
party_identifierYesref_uuid, reference, or entity_name identifying the party to update on the document
party_entity_nameNoNew entity name. Cannot be set when the party's is_internal is true

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
uuidNoIdentifier for the party - unique to the specific instance of the party. Do not show to the user unless they ask for it
addressNoThe party's address. Absent when not yet known
ref_uuidNoA static reference identifier, allowing parties in documents to be matched their corresponding party in the document's source template. Do not show to the user unless they ask for it
referenceNoA generic reference for the party. e.g. "Customer", "Employee", etc
entity_nameNoThe actual name of the party. Absent when not yet known
is_internalNoTrue if the party belongs to this account
_entity_typeNoOnly relevant for tooling. Do not show to the user

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true, readOnlyHint=false, openWorldHint=false. The description goes beyond them by disclosing a non-obvious failure mode — for account-linked parties only party_reference is mutable and other field updates will fail — plus the partial-update semantics ('only need to be sent if their value should change').

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

Conciseness5/5

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

Front-loads the one-line purpose, then the when-to-use condition, then required vs optional parameters, then the key constraint. Every sentence carries information and there is no filler.

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

Completeness5/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 no explanation, and annotations cover the safety profile. Combined with 100% schema coverage and the explicit account-party constraint, an agent has everything needed to call it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is already 100%, so the baseline is 3. The description adds real value on top: it defines party_identifier as a ref_uuid, reference, or entity_name, and clarifies that non-required fields are conditional partial updates. The enum and is_internal constraints live in the schema, so this is additive rather than duplicated.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb (edit/update) and resource (a party on a document), and the field-enumeration ('reference, entity type, entity name, address, or scope') makes it unambiguous. It is clearly distinguishable from siblings like update-document, create-document-party, and update-template-party.

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 explicit 'Use this tool when' clause gives a clear triggering condition (a party field on an existing document needs to change). It stops short of naming sibling alternatives such as create-document-party for adding a new party, so the agent must infer the add-vs-edit boundary.

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