search_portal_regex_matches

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

No annotations are provided, so the description bears the burden of behavioral disclosure. It mentions 'True regex' and 'offsets+context', indicating it returns position and surrounding text, and that it treats input as regex. However, it does not disclose destructive potential (likely read-only), performance considerations, or authentication requirements. The description adds some value but is incomplete.

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 extremely concise: two sentences that front-load the core functionality. Every sentence provides essential information with no wasted words. It is appropriately sized for a tool with many parameters.

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 19 parameters, no output schema, and no annotations, the description is too minimal. It does not explain the output format, pagination behavior, or how filters (e.g., updated_by, updated_after) work. A more complete description would include usage examples or output details.

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 parameter schema has 68% coverage, meaning some parameters are described in the schema. The description adds no parameter-specific meaning; it only gives an overview. With moderate coverage, the description should compensate for missing parameter descriptions but does not. It does not explain any parameter beyond what is in the schema.

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 'True regex over portal code (widget/provider/SI)' and provides 'offsets+context'. It distinguishes from sibling 'search_server_code' by noting it is for keyword search, implying this tool is for regex search. The verb 'search' and resource 'portal code' are specific.

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 mentions an alternative ('Server-table keyword search: search_server_code') but does not explicitly state when to use this tool vs alternatives. It implies regex search over portal code, but lacks clear context for when to choose this over other search tools. No exclusions or prerequisites are provided.

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