Skip to main content
Glama

update_document

Update an existing document you own. Omit any field to keep its current value.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugYesDocument slug
titleNoNew title
contentNoNew markdown content
expires_atNoISO 8601 expiry datetime; omit to keep current
visibilityNoNew visibility level
editor_emailsNoComma-separated emails that can edit; pass empty string to clear
allowed_domainNoDomain allowed to view, e.g. company.com; required for domain_restricted
allowed_emailsNoComma-separated emails allowed to view; pass empty string to clear
domain_can_editNoWhen true, all users in allowed_domain can edit (not just view)

TDQS

A3.9/5.0
Behavior3/5

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

Without annotations, the description carries the disclosure burden. It discloses two important behaviors: ownership is a precondition, and omitted fields retain their current values (partial update). However, it does not disclose expected return value, error behavior, or potential side effects, which is a significant gap for a mutation tool.

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?

The description is two short sentences, front-loaded with the core action, and every phrase adds value. It avoids restating the schema or including irrelevant detail.

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?

Given the tool has 9 parameters, no output schema, and no annotations, the description is minimal but covers the key behavioral rule (omit to keep). However, it fails to mention what the tool returns after a successful update, and does not clarify edge cases such as interactions between visibility and allowed_domain, or whether updating an archived document is allowed. The rich schema compensates for some, but not all, missing context.

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?

The input schema already describes each parameter in full (100% coverage), so the baseline is 3. The description adds valuable cross-parameter semantics: 'Omit any field to keep its current value' clarifies that all fields except slug are optional and that partial updates are supported. This goes beyond what the schema says individually.

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?

The description uses a specific verb ('Update') and resource ('existing document') and adds an important ownership qualifier ('you own'). This clearly distinguishes it from sibling tools like create_document, get_document, and archive_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 'you own' gives clear context for when to use the tool, but it does not explicitly mention alternatives or when not to use it (e.g., archived documents). There is no guidance on sibling tools like archive_document or create_document, so usage is implied rather than explicit.

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

A4.1/5.0
Disambiguation5/5

Each tool has a distinct role: document CRUD (create, get, update, archive), listing/searching, annotation create/list, and two auth helper tools. There is no overlap or ambiguity between them.

Naming Consistency5/5

All tools follow a consistent verb_noun pattern with snake_case (e.g., create_document, list_annotations, request_device_auth). The naming is uniform and predictable across both document and auth tools.

Tool Count5/5

With 10 tools, the server is well-scoped for document management plus required auth flow. It covers the essential operations without being bloated or too thin.

Completeness3/5

Core document operations are covered (create, read, update, archive, list, search), but there is no hard delete or unarchive, and annotations only support create/list (no update/delete). Additionally, there is no explicit tool for sharing documents despite the mention of shared docs.

Resources