pfc_query_command

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

No annotations are provided, so the description carries the burden of behavioral disclosure. It explains that the tool returns matching command paths and accepts search keywords. While it doesn't explicitly state read-only or safety, the functionality implies a safe search operation. The description adds value by mentioning case-insensitivity and version support.

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 and well-structured. It starts with the core functionality, then provides usage guidelines, examples, and related tools. Every sentence adds value without redundancy. The structure is front-loaded with the essential purpose.

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?

Given the presence of an output schema (not shown but confirmed), the description is complete. It covers the tool's purpose, parameters, usage recommendations, and links to sibling tools. No critical information is missing for effective tool selection and 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% with each parameter documented. The description adds extra context beyond the schema, such as examples for the query parameter, explanation that results are matching command paths, and default version mention. This enhances the agent's understanding of parameter usage.

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's purpose: 'Search PFC command documentation by keywords (like grep)'. It specifies the action (search), resource (command documentation), and method (by keywords). It also differentiates from the sibling tool pfc_browse_commands, which is for full documentation.

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 provides 'When to use' guidance, stating to use this tool when keywords are known but exact command path is unknown, with examples. It also lists related tools and their distinct purposes, offering clear guidance on alternative tools.

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