gateway_modules

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

The description only states 'Read-only', which hints at no destructive effects, but provides no details about behavior, such as what data is returned or any constraints. With no annotations, this is insufficient disclosure.

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 very short (4 words), but it is under-specified rather than concise. It fails to convey meaningful information within its brevity.

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 that there is an output schema, the description should at least indicate what the tool returns. The current description is completely inadequate for an agent to understand the tool's function or output.

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?

There are no parameters, so baseline 4 applies. The description does not add any parameter context, but the schema coverage is 100% (empty), so no deficiency.

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 'Read-only, REST plane.' is extremely vague and fails to specify what the tool does. It does not mention a verb or a resource, and it is indistinguishable from other read-only tools like 'gateway_info'.

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 'gateway_info' or 'gateway_performance'. The description gives no context or exclusions.

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