read_learnings

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

Discloses return behavior: 'filtered entries plus a pre-rendered markdown block'. Mentions filters and purpose to reduce repetition. No annotations provided, but description adequately covers read-only nature and output.

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?

Front-loaded with core purpose, then details. Slightly long but every sentence adds value. Could be more concise but overall 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?

With 8 parameters and no output schema, the description lacks explanation for several parameters and return format details beyond markdown block. Adequate but incomplete.

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?

Description explains file path overridability and filters (agent, decision, changed_files), but misses details on limit, include_rendered, include_archived, include_summary. Schema coverage is 0%, so description partially compensates.

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 the action 'Read' and the resource 'recent team decisions from `.squad/learnings.jsonl`', with path overridability. Distinguishes from siblings like record_learning and prune_learnings.

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?

Specifies usage context: 'Used by the /squad:review skill in Phase 5 (advisory) and Phase 10 (consolidation)'. Provides filter options but no explicit when-not-to-use or alternatives.

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