search

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

No annotations provided. The description indicates the tool performs a read-only regex search, but does not disclose error handling (e.g., invalid regex), performance implications, or authentication requirements. The behavioral disclosure 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?

Single sentence with no wasted words. The core purpose is front-loaded: 'Regex search over sprint text' immediately conveys what the tool does.

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?

Adequate for a simple two-parameter tool with no output schema. However, it does not describe the return format (e.g., list of matches with positions) or how context is formatted. Could be more complete.

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?

With 0% schema description coverage, the description adds meaning: 'Regex search' explains the pattern parameter as a regex string, and 'character context' clarifies context_size as number of characters around matches. This compensates well for the lack of schema parameter 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?

The description clearly states the tool performs a regex search over sprint text and provides character context around matches. It uses a specific verb and resource, distinguishing it from siblings like artifact_get or item_get which retrieve individual items.

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?

No guidance on when to use this tool vs alternatives (e.g., using item_get or note_get). No mention of prerequisites, limitations, or scenarios where regex search is inappropriate.

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