ruyi_search_in_sources

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

No annotations are provided, so the description must carry the full burden of behavioral disclosure. It only restates the basic action without mentioning scope (which frames/pages), return format, result limits, or behavior when nothing matches. This is insufficient for an agent to understand side effects or expectations.

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 concise sentence that is front-loaded and free of fluff. However, it is so brief that it sacrifices necessary detail, making it efficient in form but not fully adequate as standalone guidance.

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 no output schema and no annotations, the description is expected to cover scope, return values, and parameter behavior. It does neither, leaving important context missing for a tool with six parameters and moderate complexity.

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 description coverage is only 50%, and the description adds no meaning beyond the existing query parameter description. The parameters isRegex, pageIdx, and caseSensitive are left undocumented in both the description and schema, forcing the agent to guess from their names.

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 for a string or regular expression in the page's loaded JS source code. This specific verb+resource combination distinguishes it from sibling tools like ruyi_list_scripts and ruyi_get_script_source.

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 the tool is used when you need to locate a pattern within JavaScript sources already loaded in the page. However, it provides no explicit guidance on when to prefer this tool over alternatives such as fetching script sources with ruyi_get_script_source or setting breakpoints.

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