Search Discourse Forum (Optional)

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

Description adds behavioral context beyond annotations: default 10 results, max 50, optional private topics, and server requirement. Annotations cover safety (readOnlyHint, etc.) and description enhances transparency without contradiction.

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?

Description is reasonably concise but includes setup instructions and use case. Front-loaded with main purpose. Could be slightly more compact but all sentences are meaningful.

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 search tool with 3 parameters, no output schema, and rich annotations, the description is highly complete: it explains purpose, usage scenario, setup requirements, and parameter defaults, leaving no significant gaps.

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?

Input schema covers all 3 parameters with descriptions. Description adds the default of 10 results for max_results and usage context for with_private, providing value beyond the schema's static 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?

Description clearly states it searches the VeBetterDAO Discourse forum for topics, discussions, and community posts. It specifies the site and default returns, distinguishing from sibling tools like getDiscoursePost or getDiscourseTopic.

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?

Explicitly says when to use: if a proposal's IPFS description lacks a direct Discourse link, search by proposal ID or title. Also provides setup instructions and fallback suggestion.

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