insert_log

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

Annotations already declare this is a non-readonly, non-idempotent, non-destructive open-world write, so the description doesn't need to restate mutability. It adds real value beyond that: the write lands in Portkey immediately, and there is a validation failure mode tied to request_provider that an agent must satisfy before calling.

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?

Three sentences, purpose-first, then write semantics and the failure precondition, then the tracing hint. No filler, though 'writes request, response, and trace metadata into Portkey immediately' lightly restates the resource already named in the first clause.

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 17-parameter write tool with an output schema and fully documented params, the description covers what the schema can't: the intended traffic segment, the external dependency that causes failure, and how to use the span fields. An agent has enough to call it correctly.

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 coverage is 100% across 17 parameters, so the baseline is 3, but the description adds semantics the schema cannot convey — that request_provider must resolve to an existing integration, and that the metadata_span_* fields exist to stitch trace hierarchies. That is genuine meaning beyond the field-by-field descriptions.

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?

States a specific verb and resource — 'Insert log records' — and immediately narrows the scope to 'requests that bypassed the gateway', which is what separates it from the read-side siblings like get_log and the export tools. An agent can tell what this tool is for without opening the schema.

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 gives a clear triggering condition (only for traffic that bypassed the gateway) and a hard precondition: the call fails when request_provider doesn't match a configured integration. It stops short of naming the alternative path (letting the gateway log automatically) or saying when not to use it.

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