cache_keys

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

No annotations provided, so description carries burden. Discloses non-blocking SCAN scan, returns at most `count` keys, and pattern matching. Does not specify return format or pagination, but for a list operation this is adequate.

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 that efficiently convey purpose, pattern details, technical implementation (SCAN), and count limit. No superfluous words.

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?

Lacks explanation of return format (e.g., array of key strings) or pagination behavior. However, for a list-key operation with count limit, this is mostly complete. Could mention that keys are returned as strings.

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 description coverage is 67% (2 of 3 params described). Description adds value by stating pattern is optional with default '*', count has default 50 and max 500. For instance_id, it implies a cache instance ID but doesn't specify format.

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?

Description clearly states 'List keys in a cache instance matching an optional glob pattern', using specific verb 'list' and resource 'keys in a cache instance'. Mentions SCAN to avoid blocking, distinguishing from siblings like cache_get or cache_mget which retrieve values.

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?

Description explains when to use: to list keys with an optional pattern. Provides defaults (pattern=*, count=50). Lacks explicit alternatives or when-not-to-use guidance, but context from sibling tools makes it clear.

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