Skip to main content
Glama

Set Comment

set_comment

Adds or updates comments at specified addresses in an IDA Pro database, associating each address with a comment to document reverse-engineering findings.

Instructions

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

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "items": "<items>"
    },
    "name": "set_comment"
  }
}

Input Schema

NameRequiredDescriptionDefault
itemsYesList of {address, comment} objects
timeoutNoTimeout in seconds
instance_idNoREQUIRED whenever more than one database is open (from open_database's result or list_databases()); optional only while exactly one instance is live.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.0.1
    • changedInput schema / properties / instance_id / description
      Previous value: -"Instance id override"New value: +"REQUIRED whenever more than one database is open (from open_database's result or list_databases()); optional only while exactly one instance is live."
  2. 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 full burden. It states that comments are written but not whether existing comments are overwritten or appended, what happens with invalid addresses, or whether the change must be saved separately. This is a mutation tool with essentially no behavioral disclosure beyond the verb 'Set'.

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, front-loaded with the operation and followed by the required item shape; nothing is padded. It is perhaps too terse given the missing behavioral context, but the prose itself is efficient.

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

Completeness2/5

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

For a mutation tool with no annotations and no output schema, the description omits overwrite semantics, address formatting, database-open requirements, and return behavior. The schema covers parameters, but an agent still lacks what it needs to call this correctly and safely.

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 baseline is 3, and the description merely restates the schema's 'list of {address, comment} objects'. It adds no detail about the address format (hex string vs. integer) or whether 'comment' replaces prior text, which the loosely typed nested object leaves open.

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?

The description names a specific verb and resource ('Set comments at address(es)') and the item shape, so an agent knows it writes comments to addresses. It does not distinguish among comment kinds used in this domain (e.g., regular vs. repeatable, anterior vs. posterior), but no sibling tool does comments, so ambiguity risk is low.

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 guidance on when to use this tool, no prerequisites (e.g., a database must be open), and no alternatives or exclusions. The agent must infer all usage conditions from the wider toolset.

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