autotask_raw_request

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

Discloses automatic header addition (Content-Type, Accept, ApiIntegrationcode, UserName, Secret) and query parameter URL-encoding. However, it does not explicitly mention mutation behavior or potential side effects, though the method parameter implies it.

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, front-loaded with purpose, no redundant information. Every sentence contributes essential context.

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?

Covers headers, base URL, query param handling, and usage preference. Lacks details on response format or error behavior, but given it is an escape hatch, the description is sufficiently 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?

Adds value beyond the schema by explaining that queryParams are URL-encoded and appended, and that the path is resolved against a zone-resolved base URL. Schema coverage is 100% but description enriches understanding.

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 is an 'escape hatch for Autotask REST endpoints not yet wrapped by a typed tool,' which explicitly defines its purpose and distinguishes it from the many typed sibling tools.

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?

Explicitly advises 'use sparingly — typed tools are preferred for safety,' providing clear when-to-use and when-not-to-use guidance. Also explains path resolution and query parameter handling.

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