Skip to main content
Glama

update_doc

Update an existing document by modifying its title, text, or folder. Validates references and sends only changed fields.

Instructions

Update an existing document (title, text, or folder). Validates references and only sends changed fields.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
doc_idYesDocument doc_id to update
updatesYesFields to update
Behavior3/5

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

No annotations are provided, so the description carries full burden. It adds behavioral context like 'validates references' and 'only sends changed fields', which is helpful but insufficient. It does not disclose error handling, permissions, or return behavior.

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?

The description is a single sentence with no wasted words, but could be structured more clearly (e.g., bullet points). It is concise yet efficient.

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 a nested parameter and no output schema, the description should explain return values or side effects. It does not. While the description covers essential update behavior, it lacks documentation of what the tool returns or error conditions.

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 already defines all parameters. The description merely lists the fields again, adding no new meaning beyond what the schema provides. Baseline 3 is appropriate.

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 clearly states the tool updates an existing document and specifies the fields (title, text, folder), distinguishing it from create_doc and delete_doc. The verb 'update' is specific and the resource 'existing document' is unambiguous.

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 description implies usage for modifying an existing document, but does not explicitly mention when not to use it (e.g., if the document doesn't exist) nor alternatives like update_task. However, sibling tool names make resource differentiation clear.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/standardbeagle/dart-query'

If you have feedback or need assistance with the MCP directory API, please join our Discord server