Skip to main content
Glama

Update document party

update-document-party
DestructiveIdempotent

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.

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": {
      "document_uuid": "<document_uuid>",
      "party_identifier": "<party_identifier>"
    },
    "name": "update-document-party"
  }
}

Input 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

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.0
Behavior4/5

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

Beyond the annotations (destructiveHint=true, idempotentHint=true), the description explains partial-update semantics — optional fields "only need to be sent if their value should change" — and adds a real behavioral constraint the annotations cannot express: for account-linked parties only party_reference is writable and other updates will fail. It stops short of 5 because the destructiveHint is never explained in terms of what existing values are overwritten.

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

Conciseness4/5

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

Front-loaded purpose sentence followed by a short bulleted eligibility list and a trailing constraint note; every sentence carries information. Slightly list-heavy for the amount of content, but no filler.

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?

Output schema exists so return values need no explanation, and the description covers required identifiers, optionality, and the account-party restriction. The one remaining ambiguity is whether passing an explicit null clears a field versus leaving it untouched, which an agent would still need to guess.

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 100%, so the baseline is 3; the description earns above that by clarifying that party_identifier accepts a ref_uuid, reference, or entity_name (with the identifier pair being the only required inputs) and by adding the account-party write restriction that the schema only partially encodes via the is_internal notes.

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 opens with a specific verb+resource pair ("Edit the details of a party on a document") and enumerates the editable fields, which lets an agent distinguish it from create-document-party and update-document-signatory. It does not explicitly name the template-scoped sibling update-template-party as a different target, so it stops short of a 5.

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?

A dedicated "Use this tool when" block states the triggering condition (a party's reference, entity type, entity name, address, or scope must change on an existing document), which maps directly onto the mutable parameters. It gives no explicit exclusions or named alternative for creation, so it falls short of 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