Skip to main content
Glama

Set Comment

set_comment

Add comments at specific addresses in IDA Pro to document reverse engineering findings. Supports multiple address-comment pairs in one call.

Instructions

Set comments at address(es). Each item: {address, comment}.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
itemsYesList of {address, comment} objects
timeoutNoTimeout in seconds
instance_idNoInstance id override

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.9.7

TDQS

C2.9/5.0
Behavior2/5

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

No annotations are provided, so the description carries the entire behavioral burden, and it discloses almost nothing: it doesn't say whether existing comments are overwritten, whether addresses accept names vs hex, whether invalid addresses error or are skipped, or what the response contains. The only trait revealed (bulk application via 'address(es)' and 'each item') largely restates the schema.

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 short sentences, zero filler, and the purpose is front-loaded before the payload shape. It is appropriately sized for a simple setter, though it is arguably under-specified rather than deliberately tight.

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 a 3-parameter tool with full schema coverage and no output schema, the description covers purpose and payload shape adequately, and return values need not be explained. However, key operational facts for a mutation tool — overwrite semantics, address format, error handling — are absent.

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 the schema already documents items, timeout, and instance_id. The description's 'Each item: {address, comment}' duplicates the items schema entry without adding format detail (address syntax, comment length, duplicate-address behavior), so 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?

States a specific verb+resource ('Set comments') plus the target ('at address(es)'), so an agent immediately knows this writes annotations into the disassembly. No sibling comment tool exists to differentiate from, so no sibling-routing is needed, but it never names the domain (IDA/database) explicitly.

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

Usage Guidelines2/5

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

There is no when-to-use, when-not-to-use, or prerequisite guidance (e.g., that a database must be open first, unlike the closed-schema check_connection/select_database tools). Usage is only inferable from the verb, which is the minimum.

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