doc_bulk

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

With no annotations provided, the description carries full burden but offers minimal behavioral insight. It mentions 'refresh strategy' but doesn't explain what that means, nor does it cover critical aspects like atomicity, error handling, performance implications, or required permissions for bulk operations.

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 reasonably concise with a purpose statement, parameter list, and example. However, the example is lengthy and could be simplified, and some sentences (like the parameter descriptions) are under-specified rather than truly concise.

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?

For a bulk operation tool with 2 parameters, 0% schema coverage, no annotations, and no output schema, the description is inadequate. It lacks details on operation types, error behavior, performance characteristics, and comparison to siblings, making it insufficient for safe and effective use.

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 but provides incomplete information. It lists parameters and gives an example format, but doesn't explain what 'operations' contains beyond a basic structure, what actions are valid, or what 'refresh' controls. This leaves significant gaps in understanding parameter usage.

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 states '批量操作文档' (bulk operations on documents), which provides a basic purpose but is vague about what specific operations are supported. It doesn't distinguish from sibling tools like doc_bulk_simple, doc_index, or doc_update, leaving ambiguity about when to choose this over alternatives.

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?

No guidance is provided on when to use this tool versus alternatives like doc_bulk_simple or individual document operations. The example shows usage but doesn't explain context or trade-offs, leaving the agent to infer usage from parameter structure alone.

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