api_request

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

Describes HTTP method, path, params, body but does not disclose return value format, error behavior, or authentication details. With no annotations, more transparency on response would be beneficial.

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?

Reasonably concise with a clear 'Args' section. The example of fetching openapi.json adds extra but valuable information. Could trim slightly but overall well-structured.

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?

Provides enough to use the tool: method, path, params, body, and a link to full docs. However, no output schema or description of return value is a gap for completeness. Adequate but not exemplary.

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?

Despite 0% schema description coverage, the docstring clearly explains each parameter: method (GET/POST/PATCH/DELETE), path (relative to base), params (query parameters), body (JSON for POST/PATCH). Adds useful context beyond bare schema.

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?

Description explicitly states it calls any Aikount API endpoint not covered by a dedicated tool, clearly distinguishing it from 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?

Provides clear guidance to use when an endpoint is not wrapped by a dedicated tool, and suggests fetching the OpenAPI spec for discovery. No explicit when-not-to-use, but context is sufficient.

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