Get Discussions

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

The readOnlyHint annotation already establishes the tool as a safe read operation. The description adds meaningful behavioral detail beyond that: it explains the hierarchical scoping behavior for courseId, forumId, and topicId, telling the agent exactly what each level of input returns.

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 three focused sentences: the first states the purpose, the second gives user-intent triggers, and the third explains parameter usage. No filler or redundant content, and the most important scoping guidance is front-loaded.

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 retrieval tool with 3 well-documented parameters and no output schema, the description adequately covers invocation, parameter combinations, and expected results at each level. An agent has everything needed to call it correctly.

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 100%, so the baseline is 3. The description goes beyond the schema by explaining parameter combination semantics, such as 'Provide just courseId to list all forums and their topics' and 'Add both forumId and topicId to get all posts in a specific discussion topic,' which adds real value.

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 uses a specific verb and resource ('Fetch discussion board content for a course including forums, topics, and posts') and clearly differentiates this tool from siblings like announcements and assignments. It also identifies the exact user intents it serves, so an agent can select it accurately.

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 explicitly states when to use the tool ('when the user asks about discussion boards, forum posts, class discussions, or wants to see what's been posted') and explains how parameter combinations change the scope. It does not mention when not to use it or name alternatives, but the context is clear enough.

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