upsert_documents

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

The description explains the upsert logic (insert if missing, update if exists) and mentions return type (success message with count). Annotations only provide idempotentHint, so the description adds behavioral detail beyond structured data.

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 concise (two paragraphs plus parameter listing) and front-loaded with the core operation. Every sentence serves a purpose, though the parameter listing could be more compact.

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?

The description covers the basic operation and return type, but lacks details on error scenarios, default values, or limitations. Given the presence of an output schema (not shown) and rich input schema, it is minimally adequate but could be more complete.

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?

The description restates parameter names and types from the schema without adding new meaning. Since schema descriptions are already detailed (e.g., DocumentInput fields), the tool description offers minimal additional semantic value.

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 tool's purpose with specific verb and resource: 'Insert new documents or update existing ones by ID.' This distinguishes it from sibling tools like insert_documents and update_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 does not provide guidance on when to use upsert versus insert or update, nor does it mention prerequisites or exclusions. It only describes the combined behavior, leaving the agent to infer usage context.

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