uniswap_pool_state

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

With no annotations, the description carries full burden. It indicates a read-only operation via StateView, but lacks disclosure of potential error conditions, rate limits, or gas implications. Adequate but incomplete.

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 sentences front-loading action and output, then alternative input methods. No wasted words, highly efficient.

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 8 parameters and no output schema, the description covers the two input methods and the returned data fields. However, it omits mention of error handling or return structure beyond listing the values. Mostly complete for a read tool.

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?

The description explains that poolId can be omitted to derive from PoolKey parameters, adding meaning beyond the schema. Only poolId has a schema description (13% coverage); this clarifies the relationship between parameters, significantly aiding usage.

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 clearly states the tool reads a v4 pool's slot0 via StateView, listing specific data (sqrt price, tick, protocol fee, LP fee). It distinguishes from siblings like uniswap_pool_liquidity by focusing on slot0 state.

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 implies usage for reading slot0 data but does not explicitly guide when to use this tool over alternatives like uniswap_find_pool or uniswap_pool_liquidity. No exclusions or when-not-to-use provided.

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