post_w_company_external_scan

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

No annotations are provided, so the description carries the full burden. It says 'Scan external endpoint' and calls the POST endpoint, implying a mutation, but does not disclose side effects, required permissions, rate limits, or confirmation of action. It does not clarify whether this is a synchronous long-running job or just a trigger.

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 a single, compact sentence that quickly explains where each argument goes. It is front-loaded with the action and endpoint, and there is no filler, though the sentence is slightly run-on.

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 tool has an output schema, but the description doesn't explain what the response contains or how to interpret the scan initiation. It also lacks detail on the request body structure and any expected authentication, so an agent calling it would be guessing on payload and interpreting results. This is insufficient for a complex endpoint.

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%, and the parameters are generic (body, query, headers, path_params) with no additionalProperties constraints. The description only says to provide route IDs in path_params and filters/pagination in query, but does not specify what filters or pagination keys are expected, nor the structure of the body. It adds minimal value beyond the property names.

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 a clear action ('Scan external endpoint') and the HTTP method/path, but it is somewhat generic — 'external scan' is weakly defined. Among siblings there are many post_w_* tools and some external_scan-related get reports, but the description doesn't distinguish what this specific operation returns or does beyond the endpoint name.

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?

It specifies where to put path, query, headers, and body, but gives no guidance on when this tool is appropriate versus alternatives (e.g., get_r_report_queries_external_asset_externalscan for retrieving scan results). No mention of prerequisites, such as needing existing company settings or whether a scan must be triggered elsewhere.

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