read_material

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

Annotations already declare readOnlyHint, idempotentHint, and non-destructive behavior. The description adds valuable caveats: 'Code and formulas are not executed' (a safety note) and 'Returns text in chunks with nextOffset' (pagination behavior), which go beyond the annotations. This aligns with and enriches the annotated safety profile.

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?

The description is concise, packed into three sentences with the core action and formats front-loaded, followed by important caveats and return structure. No redundant filler; every sentence contributes value.

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?

For a read-only tool with strong annotations, the description covers supported formats, safety (no execution), pagination (chunks, nextOffset), and external resource behavior. It lacks explicit detail on the exact output structure or how courseId/topicId relate, but given the absence of an output schema and the read-only annotations, it is fairly complete.

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 50%: courseId and topicId have descriptions ('Exact Brightspace numeric identifier from another tool'), but offset and maxChars have only defaults/ranges. The description implies 'chunks' and 'nextOffset', clarifying the offset parameter's purpose, but does not explain maxChars or the relationship between courseId and topicId. It partially compensates for the schema gap but not fully.

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 verb ('Extract and index') and the resource ('lecture material'), and enumerates supported formats (PDF, DOCX, etc.). It is specific enough to understand the tool's function, though it does not explicitly distinguish itself from siblings like download_material or read_course_page, which also deal with course content.

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 the tool is for extracting text content from lecture materials, but provides no explicit guidance on when to prefer it over alternatives. It does not mention exclusions (e.g., 'use download_material for binary files') or name sibling tools, leaving the agent to infer usage based on the formats listed.

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