postit.search

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

No annotations are provided, so the description carries the full burden. It conveys that this is a read-only regex search and adds the 'grep-like' trait, but it does not disclose behavior around directory scoping, recursion, result limiting, or output format. The description is minimal but not misleading.

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 a single sentence, front-loaded with the core action 'Regex search'. Every word contributes meaning, with no filler or redundant information. It is appropriately sized for the tool's simplicity.

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?

With five parameters and no annotations, a one-sentence description is thin. It covers the core purpose but omits context about directory targeting, recursion defaults, and result handling. The presence of an output schema mitigates some ambiguity about return values, but the description still lacks depth for a multi-parameter tool.

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?

The schema has zero descriptions for its fields, so the description must compensate. It clarifies that 'pattern' is a regex and that 'scope' covers names and/or bodies, but it does not explain 'dir', 'limit', or 'recursive', leaving those to be interpreted from their names and defaults.

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 specific verb 'search' and the resource 'postit names and/or bodies', further clarified by 'grep-like' to indicate regex matching. This distinguishes it from sibling read/list tools such as postit.read or postit.ls.

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 usage for regex-based search across postit fields but provides no explicit guidance on when to choose this tool over siblings, nor any exclusions or alternative recommendations. The use case is inferred from the verb 'search'.

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