cvcue_api_execute

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

With no annotations, the description carries the full burden and does so: pagination convention (0-based startindex + pagesize), location subtree scoping, selective-fetch failure code, the modelspecific=false workaround, oversized-result refusal with shape preview, and secret redaction with a warning not to echo ***REDACTED*** back in a write body.

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?

Front-loaded purpose followed by a block of practical conventions and a scannable example list; nearly every line carries operational value. It runs long for a single tool, and the parenthetical "step 4 of API discovery" is cryptic without the earlier steps in view.

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?

No output schema exists, and the description compensates by explaining response-side behavior: redacted secrets, huge devicetemplate payloads, selective field fetch, and refusal of oversized results. For a six-parameter generic dispatcher, 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%, so a 3 is the baseline, but the description adds real meaning: it shows how path_params substitute {placeholders}, what query_params typically carry for list endpoints, and gives four concrete invocation examples spanning path, query, and path params.

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?

"Execute ANY CV-CUE API call (step 4 of API discovery)" states a specific verb and resource and makes clear this is the generic escape hatch, with paths anchored to the API base URL. It doesn't name which siblings it supersedes (e.g. cvcue_list_aps), so differentiation is left implicit.

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 "step 4 of API discovery" framing gives an explicit position in the workflow, and the non-GET line states a hard precondition (writes must be enabled for the connection). No explicit "prefer the typed tools when they cover your case" routing, so one gap remains.

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