Skip to main content
Glama

update_documents

Update documentation files with smart merge, checking for version changes and preventing concurrent updates via file locking.

Instructions

Update documentation files using the configured docroot.

Checks for version changes and updates files using smart merge strategy. Uses file locking to prevent concurrent updates.

Arguments

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
argsYesArguments for update_documents tool.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior3/5

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

The description mentions version checking, smart merge strategy, and file locking, which adds behavioral context beyond a basic 'update'. However, with no annotations, it fails to disclose permissions, conflict behavior, or whether the operation is reversible.

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

Conciseness3/5

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

The description is brief but includes an empty '## Arguments' section, which is unnecessary and slightly wasteful. It could be more concise without that placeholder.

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

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Despite having an output schema (not shown), the description lacks crucial details such as parameter documentation, usage context, and differentiation from similar tools, making it incomplete for effective tool selection.

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

Parameters2/5

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

The only parameter 'args' has a generic description and no defined properties. The description does not clarify what arguments are valid, leaving the agent with no meaningful guidance beyond the schema.

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 the verb 'update' and the resource 'documentation files', but does not differentiate from the sibling tool 'document_update', which may have overlapping functionality.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no guidance on when to use this tool versus alternatives like 'document_remove' or 'document_update'. No exclusions or prerequisites are mentioned.

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/deeprave/mcp-guide'

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