run_onyx_ingest

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

The description discloses it is incremental by default (new files only) and mentions the full_sync parameter for full re-index. It also specifies the host (ONYX_API_URL). Annotations (readOnlyHint=false, idempotentHint=true, destructiveHint=false) are consistent. No contradictions.

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?

A single, well-structured sentence that front-loads the action ('Trigger an incremental Onyx knowledge base ingest') and then lists indexed resources. No unnecessary words.

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?

With a single parameter, no output schema, and annotations providing behavioral hints (idempotent, non-destructive), the description is fairly complete. It could add return value info (e.g., job ID or status) but is adequate without it.

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 only parameter (full_sync) is already described in the schema (100% coverage). The description adds no further semantics about the parameter beyond the schema, but the overall tool purpose is clear. Baseline of 3 is appropriate.

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 it triggers an Onyx knowledge base ingest, listing specific resources indexed (strategy research, marketplace listings, etc.). It distinguishes from sibling tools like get_onyx_status or onyx_search by describing an action rather than a query.

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 it is used to trigger an ingest but does not provide explicit guidance on when to use this tool versus alternatives (e.g., when to trigger vs. when to query). No exclusions are mentioned, but context from sibling list (mostly getters) suggests this is the action tool.

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