Skip to main content
Glama

search_text

Search rendered IDA Pro listings for specific text patterns. Quickly locate disassembly lines or comments by literal or regex match, returning one hit per address.

Instructions

Search the rendered listing using IDA's native text search (fast C++ scan).

Discovers candidate EAs with ida_search.find_text(), then renders each hit once via ida_lines.generate_disassembly() to extract matching lines and classify them as disasm or comment. Returns one hit per EA.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMax hits per page (default: 30, max: 500)
regexNoTreat pattern as a regex (uses IDA's SEARCH_REGEX)
startNoCursor: address to resume from (hex or symbol). Empty = first segment.
includeNo'disasm' | 'comments' | 'all' (default: all)all
patternYesText to search for in the rendered listing (literal substring by default)
code_onlyNoRestrict search to executable segments (default: true)
instance_idYes必须提供的 instance_id(或 client_id),用于将请求精确路由到特定的 IDA 实例。请先调用 instance_list 查看并选择合适的客户端 ID。
case_sensitiveNoCase-sensitive match (default: false)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.1.0

TDQS

B3.2/5.0
Behavior2/5

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

No annotations and no output schema, so the description carries the full burden. It discloses the pipeline and that hits are classified as disasm/comment, but says nothing about result ordering, permissions, performance/rate characteristics, or what the cursor-based pagination returns. For a paged search tool with zero structured coverage, this is a notable gap.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two tight paragraphs with no filler; the core behavior is front-loaded. The internal API names are slightly implementation-flavored but justify the 'native C++ scan' claim, so they still earn their place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For an 8-parameter, paged search tool with no output schema and no annotations, the description covers the return shape only in outline (one hit per EA, classified). It omits pagination/ordering expectations and the routing requirement of instance_id, leaving a few gaps an agent must fill from the schema.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so every parameter including limit, regex, start, include, and code_only is already documented in the schema. The description adds no syntax or format detail beyond that, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

It states a precise verb+resource ('search the rendered listing') and even names the mechanism (ida_search.find_text over generate_disassembly output). It clearly differentiates from raw-byte search by specifying 'rendered listing', though it stops short of naming the closest siblings (find, find_regex, find_bytes) directly.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The phrase 'rendered listing' implies this is for disassembly-text/comments rather than raw bytes, which hints at when it beats find_bytes. But there is no explicit when-to-use or when-not-to-use versus find, find_regex, or entity_query, leaving the routing decision mostly to inference.

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