Update a document name or description. Content cannot be changed.
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | ||
| description | No | ||
| document_id | Yes | ||
| knowledgebase_id | Yes |
| Name | Required | Description | Default |
|---|---|---|---|
| data | No | ||
| message | No |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description adds context beyond annotations: it specifies that only name/description can be updated and content is immutable. Annotations already indicate it is a write operation (readOnlyHint=false), not destructive (destructiveHint=false), and idempotent (idempotentHint=true), so the bar is lower and the description provides useful additional detail.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is extremely concise, consisting of two short sentences that convey essential information without any fluff. Every word is meaningful and no unnecessary details are present.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the presence of annotations and an output schema, the description is reasonably complete for a simple update tool. It covers the key constraints (only name/description, not content) but could benefit from mentioning response behavior or prerequisites. Overall, it is adequate but not exhaustive.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
With schema description coverage at 0%, the description partially compensates by stating the updatable fields (name, description). However, it does not mention the required parameters (document_id, knowledgebase_id) or provide any details about their types or role, leaving a significant gap.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
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 'document', and specifies what can be updated (name or description) and what cannot (content). This differentiates it from sibling tools like create_document, delete_document, get_document, and list_documents.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implicitly indicates usage for updating document metadata, but does not explicitly state when not to use or provide direct comparisons to alternatives. However, the context from sibling names and the clear scope make it easy to infer appropriate use.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.
Most tools target distinct resources and actions clearly (e.g., create_assistant vs create_campaign). However, there is some overlap like get_outbound_assistants vs get_assistants and list_all_phone_numbers vs get_phone_numbers, causing minor ambiguity.
Tools follow a consistent verb_noun pattern with underscores (e.g., create_document, delete_label, get_voices). Only minor deviations exist, such as generate_ai_reply and list_all_phone_numbers, but overall the pattern is maintained.
With 75 tools, the server is excessively large. Although the domain is broad (assistants, calls, messaging, etc.), the number of tools makes it difficult for agents to navigate and select the correct one, reducing coherence.
The tool set covers CRUD operations for most resources, plus webhooks, AI replies, and reference data fetching. Minor gaps exist (e.g., no delete_conversation, no attach phone number to assistant), but the surface is largely comprehensive for the platform's purpose.
