rlm.docs.peek

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

Discloses 'Enforces max_chars_per_peek' and explains parameter semantics (start inclusive, end exclusive, -1 for end). With no annotations, description does a good job. Minor gap: behavior if max_chars exceeded is not specified.

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?

Short, front-loaded purpose sentence. Argument list clear. Could use bullet points or more structure, but overall concise and 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?

Explains all parameters and behavioral constraint. Output schema exists so return format need not be described. Minor omission: the actual max_chars value not provided (may be assumed or retrieved elsewhere). Still complete for usage.

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%, but description fully explains all 4 parameters: session_id, doc_id, start default 0, end default -1 with explicit interpretation. Fully compensates for lack of schema descriptions.

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 'View a portion of a document' with a specific verb and resource. Distinguishes from siblings like load (whole doc) and list (list docs). The constraint 'Enforces max_chars_per_peek' adds clarity.

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?

Implied usage from description: for partial document viewing. But no explicit when-to-use or when-not-to-use compared to alternatives like rlm.docs.load. No mention of prerequisites or context.

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