get_exchange_details

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

With no annotations provided, the description carries the full burden and does so thoroughly. It discloses that the operation is read-only, not confirm-gated, returns exactly one exchange, never enumerates all exchanges, and returns OctoBot's JSON body unchanged. This is far beyond minimal and gives the agent accurate behavioral expectations.

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 front-loaded with a clear one-sentence summary, then proceeds with important caveats. It is somewhat long, but nearly every sentence contributes necessary behavioral or usage nuance. Minor extras like the source file reference and 'NFR-8' are acceptable context rather than padding.

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?

For a tool with one optional parameter and no output schema, this description is complete. It covers the endpoint mapping, parameter semantics, single-result guarantee, read-only nature, confirmation requirements, and return behavior. An agent has everything needed to call it correctly and interpret the result.

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 compensate, and it does. It explains that exchange_name, when provided, selects the matching exchange, and when omitted, the tool returns OctoBot's 'first exchange.' This adds real meaning to the otherwise bare schema definition.

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 first sentence uses a specific verb and resource: 'Fetch ONE exchange's name and internal id.' It clearly scopes the tool to a single exchange and distinguishes it from any list-style tool by emphasizing 'ONE' and later 'It does NOT enumerate every exchange.'

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?

The description gives clear context about when the tool is appropriate, including the optional exchange_name behavior and the fallback to 'the first exchange.' It also provides a strong exclusion: do not call this tool expecting a full exchange list. However, it does not name a specific alternative tool to use when a full list is needed.

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