Skip to main content
Glama

update_document

Update a document. Omitted fields unchanged.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesThe id of the document to update, as returned by create_document or list_documents.
feeNoThe cost associated with the document, e.g. a renewal or issuance fee. Omit to leave unchanged; when supplied, replaces the whole fee.
notesNoFree-text notes about the document. Omit to leave unchanged.
titleNoA custom title for the document. Omit to leave unchanged.
documentTypeNoThe kind of document being stored. Omit to leave unchanged.
documentNumberNoThe document's reference or serial number, e.g. a passport number or insurance policy number. Omit to leave unchanged.
issuingAuthorityNoThe organization or authority that issued the document. Omit to leave unchanged.
renewalCronExpressionNoReserved for a future renewal-reminder schedule. Currently accepted but not persisted or acted on by document updates — has no effect yet.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
itemsYes
titleNo
messageNo
variantNo

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. Changed16 schema fields changed
    • addedInput schema / examples
      Added value: +[
      +  {
      +    "id": "01928e4a7d3f7b9ac1e3f6d8b2a4c710",
      +    "issuingAuthority": "HM Passport Office",
      +    "notes": "Renewed for another 10 years."
      +  }
      +]
    • addedInput schema / properties / documentNumber / description
      Added value: +"The document's reference or serial number, e.g. a passport number or insurance policy number. Omit to leave unchanged."
    • addedInput schema / properties / documentNumber / examples
      Added value: +[
      +  "512345678"
      +]
    • addedInput schema / properties / documentType / description
      Added value: +"The kind of document being stored. Omit to leave unchanged."
    • addedInput schema / properties / documentType / examples
      Added value: +[
      +  "Passport"
      +]
    • addedInput schema / properties / fee / description
      Added value: +"The cost associated with the document, e.g. a renewal or issuance fee. Omit to leave unchanged; when supplied, replaces the whole fee."
    • addedInput schema / properties / fee / properties / currencyCode / examples
      Added value: +[
      +  "GBP"
      +]
    • addedInput schema / properties / fee / properties / value / examples
      Added value: +[
      +  8250
      +]
    • addedInput schema / properties / id / description
      Added value: +"The id of the document to update, as returned by create_document or list_documents."
    • addedInput schema / properties / id / examples
      Added value: +[
      +  "01928e4a7d3f7b9ac1e3f6d8b2a4c710"
      +]
    • addedInput schema / properties / issuingAuthority / description
      Added value: +"The organization or authority that issued the document. Omit to leave unchanged."
    • addedInput schema / properties / issuingAuthority / examples
      Added value: +[
      +  "HM Passport Office"
      +]
    • addedInput schema / properties / notes / description
      Added value: +"Free-text notes about the document. Omit to leave unchanged."
    • changedInput schema / properties / renewalCronExpression / description
      Previous value: -"Cron expression for renewal"New value: +"Reserved for a future renewal-reminder schedule. Currently accepted but not persisted or acted on by document updates — has no effect yet."
    • addedInput schema / properties / title / description
      Added value: +"A custom title for the document. Omit to leave unchanged."
    • addedInput schema / properties / title / examples
      Added value: +[
      +  "UK Passport"
      +]
  2. Changed1 schema field changed
    • addedInput schema / properties / title
      Added value: +{
      +  "type": "string"
      +}
  3. First observed

TDQS

A3.6/5.0
Behavior3/5

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

Annotations indicate the tool is not read-only and not destructive, but are minimal. The description adds the key behavior that omitted fields remain unchanged, which is useful. However, it does not disclose other traits like behavior on invalid id, return value details, or side effects beyond the partial update.

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?

Two short sentences with no filler. Each sentence carries essential meaning: the action and the partial-update behavior. Perfectly concise for its purpose.

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?

The tool has a rich schema with 8 parameters, nested objects, and an output schema, so the description need not explain return values or parameter details. The description provides the critical partial-update behavior, but could optionally mention the renewalCronExpression caveat (though that is already in the schema). Overall it is complete enough given the supporting structures.

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

Parameters3/5

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

Schema description coverage is 100%, so the schema fully documents all parameters. The description only restates the 'omit to leave unchanged' concept already present in the schema, adding no new parameter-level detail but also not needing to.

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 clearly states 'Update a document' with a specific verb and resource. It distinguishes from sibling update tools by naming the document resource, though it does not explicitly contrast with alternatives like create_document or delete_document.

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?

The phrase 'Omitted fields unchanged' implies a partial update usage pattern, but the description does not explicitly state when to use this tool versus alternatives or provide exclusions. The usage is inferred from the update semantics rather than explicitly prescribed.

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.

TDQS

A3.9/5.0
Disambiguation5/5

Each tool targets a distinct resource and action, with clear descriptions separating similar-sounding tools like create_calendar_event vs create_recurring_calendar_event. Shopping list operations (add, buy, remove, update) are clearly delineated.

Naming Consistency5/5

All tools follow a verb_noun snake_case pattern: create_*, list_*, update_*, delete_*, get_*, etc. Even special operations like store_memory, recall_memory, and skip_recommendation fit the pattern.

Tool Count1/5

With 68 tools, this server vastly exceeds a reasonable scope; the instruction manual indicates 50+ tools is an extreme mismatch. The breadth suggests the server should be split into focused sub-servers (tasks, shopping, calendar, etc.) rather than a single monolithic interface.

Completeness5/5

The tool surface covers full CRUD/lifecycle for all major resources: tasks, shopping, calendar, contacts, documents, appliances, vehicles, pets, recipes, meal plans, subscriptions, and memories. Additional features like house review, weather, and profile round out the household management domain.

Resources