restful

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

The description mentions that data is for POST/PATCH (implying mutation) but does not disclose behavioral aspects like authentication, rate limits, error handling, or that arbitrary REST calls can be destructive. With no annotations, the description carries full burden but remains insufficient.

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 concise, uses a clear 'Args:' list, and front-loads the main purpose. However, a more standard formatting (e.g., markdown) could improve readability slightly.

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?

Given no annotations or output schema, the description explains parameters but omits return value, error behavior, and any side effects. For a raw API tool that can execute arbitrary operations, more completeness is needed.

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 0%, so the description must explain each parameter. It does so effectively: path with an example, method with default, params as query parameters, data for POST/PATCH. This adds meaningful context beyond the schema's type definitions.

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 'Makes a direct REST API call to Salesforce,' which is a specific verb and resource. It distinguishes itself from sibling tools like create_record and run_soql_query by indicating it is a raw API call, not a specialized operation.

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?

No guidance is provided on when to use this tool versus alternatives such as create_record or run_soql_query. It also lacks prerequisites or caveats about using raw REST calls, e.g., requiring knowledge of Salesforce API endpoints.

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