searchPatternFlyDocs

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

No annotations provided, so description carries full burden. It describes search behavior (case-insensitive, partial, wildcard) and return types. Implies read-only, non-destructive operation. Lack of explicit auth or rate limit info is acceptable for a search tool.

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 with clear sections for usage and returns. First sentence captures purpose. No wasted words; every sentence adds 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?

No output schema, but description explains return values (bullet points). Parameters fully covered. Complexity moderate; workflow with sibling tool is explained. Complete enough for correct agent invocation.

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 coverage is 100%, baseline 3. Description adds value by explaining wildcard support and version examples beyond schema descriptions. For searchQuery, it clarifies partial and full matches.

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 searches PatternFly resources, returns component names with documentation URLs, and supports case-insensitive partial and wildcard matches. It distinguishes from sibling tool usePatternFlyDocs by explaining the workflow.

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?

Provides explicit usage steps: input a searchQuery, then use returned data with usePatternFlyDocs. Includes what is returned. No exclusion criteria or when-not-to-use mentioned, but the context is clear.

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