Browse Log Files

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

Discloses key behaviors: file content limited to 512KB, directory listing vs file fetch, pagination via total_lines. Aligns with annotations (readOnlyHint, idempotentHint, non-destructive). 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?

Well-structured: brief overview, bullet-point behaviors, note on alternative tool, then clear Args list. Every sentence adds value; no redundancy or extraneous information.

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?

Completely covers the tool's functionality given its complexity (5 params, 0 required, no enums) and sibling tools. Explains core use, alternative tool, and all parameters. Output schema exists, so return details are not needed, but pagination info is included.

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?

Despite 0% schema description coverage, the description provides detailed semantics for all 5 parameters: uuid, tenant, path (with behavior examples), url (alternative to uuid+tenant), and max_lines (limits file content, includes total_lines count).

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's purpose: 'Browse or fetch files from a build's log directory.' It details three specific behaviors (listing top-level, listing subdirectory, fetching file content) and distinguishes from sibling tools like get_build_log and tail_build_log.

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?

Explicit guidance on when to use each path pattern. Provides clear advice to use get_build_log for filtered reads of large files with regex and line ranges. Also explains the max_lines parameter and response includes total_lines for pagination.

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