Vaiz MCP

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

With no annotations provided, the description carries full burden for behavioral disclosure. It mentions the append/replace functionality, which is useful, but doesn't cover critical aspects like whether this is a destructive operation, what permissions are required, how conflicts are handled, or what the response looks like. For a mutation tool with zero annotation coverage, this leaves significant behavioral gaps.

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 appropriately concise with two sentences that efficiently convey the core functionality and key behavioral aspect (append/replace). It's front-loaded with the main purpose. No wasted words, though it could potentially benefit from slightly more structure for complex usage scenarios.

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 complexity of a document editing tool with no annotations, no output schema, and 0% schema description coverage, the description is incomplete. It covers the basic purpose and append/replace mode but misses important context like error conditions, response format, permissions needed, and how it interacts with sibling tools like 'get_document_history'.

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?

Schema description coverage is 0%, so the description must compensate. It mentions 'append to existing content or replace it entirely,' which aligns with the 'replace' parameter in the schema, adding useful context about the boolean's purpose. However, it doesn't explain the 'documentId' or 'description' parameters beyond what's implied by the tool name, leaving their semantics partially unclear.

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 action ('Edit') and target ('document content of a task, milestone, or standalone document'), which is specific and actionable. It distinguishes from siblings like 'edit_task' by focusing specifically on document content rather than broader task properties. However, it doesn't explicitly contrast with 'get_document' or other read operations.

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 implies usage context by mentioning what can be edited (task, milestone, standalone document) and the append/replace modes. However, it doesn't provide explicit guidance on when to use this versus alternatives like 'edit_task' or 'create_task_comment', nor does it mention prerequisites like needing document access or when replacement vs. append is appropriate.

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