Rustchain Epoch

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

With no annotations, the description carries the full disclosure burden and does so well: it lists all returned values, states that total_supply_rtc is fixed at 2^23, and explains slot length, epoch length, and reward distribution. It does not discuss failure modes or freshness, but for a parameterless read-only lookup those are minimal gaps.

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?

Two compact sentences are front-loaded with the core purpose and followed by a precise return-value summary plus key constants. Every sentence contributes useful information, and the formatting makes the returned fields easy to scan.

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 no-parameter read-only information tool with an output schema, the description is complete: it names each returned field, defines domain-specific terms like slot and epoch, and notes the invariant total supply constant. An agent can call it correctly without additional context.

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 zero parameters, so parameter documentation is not applicable. The description does not waste space on input semantics; the baseline of 4 applies and no misleading parameter claims are made.

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?

States a specific verb and resource ('Get current RustChain epoch information') and enumerates the exact fields returned, including epoch number, slot, miners count, reward pot, blocks per epoch, and total_supply_rtc. This is specific enough to distinguish it from siblings like rustchain_stats or rustchain_health, which target different network-wide metrics.

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 makes the intended use clear: call this to retrieve current epoch-level RustChain data, and it defines slot/epoch semantics so an agent knows what context this tool addresses. It does not explicitly name alternatives or exclusion conditions, so it falls short of a 5 but provides clear contextual guidance.

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