Ordiscan: getAlkaneInfo

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

Annotations already declare readOnly, destructive, idempotent, openWorld hints. Description adds value by specifying the returned fields (name, symbol, etc.) and hints at contract details being conditional ('if applicable'). No contradictions.

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?

Single sentence, zero waste. All information is front-loaded and concise.

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 output schema, description adequately lists the metadata fields returned. Lacks explicit error handling (e.g., 'returns null if not found') but sufficient for a simple read-only metadata tool amidst many similar siblings.

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 already fully documents the single 'id' parameter with format and requirement. Description adds no extra meaning beyond the schema's coverage. Baseline 3 is appropriate.

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?

Clearly states 'Fetch metadata for a single Alkane by its protocol ID' with specific fields (name, symbol, supply, type, contract details). Distinguishes from siblings like listAlkanes (for listing multiple) and getAlkaneAddressBalance (for address-specific queries).

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?

Implies use for single alkane info but does not explicitly contrast with alternatives like listAlkanes for bulk queries or getAlkaneAddressBalance for address-based lookups. No explicit when-to-use or when-not-to-use guidance.

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