Skip to main content
Glama

Set Inline Comment

set_inline_comment
DestructiveIdempotent

Writes an inline instruction comment at a hexadecimal address and returns whether readback matched. Pass an empty string to clear the comment; it mutates analysis metadata.

Instructions

Write an inline instruction comment at a hexadecimal address and return whether readback matched. An empty comment clears it; Hopper may flatten newlines, producing false on exact readback. This mutates analysis metadata.

Example tool call

This call uses example arguments supplied in the tool’s input schema.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "address": "0x1000",
      "comment": "calls parser"
    },
    "name": "set_inline_comment"
  }
}

Input Schema

NameRequiredDescriptionDefault
addressYesA provider-normalized address; default memory uses 0x-prefixed hexadecimal
commentYesExact analyst comment text to write.
documentNoThe active target's provider document name; use open_binary to switch targets

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already flag readOnlyHint=false and destructiveHint=true, but the description adds real behavioral context beyond them: the call returns a readback comparison, and Hopper's newline flattening can make an exact readback return false, which is a non-obvious failure mode an agent would otherwise misread. It stops short of saying what happens on an invalid address or why idempotency holds for clearing.

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?

Three short sentences, front-loaded with purpose then caveats, with no filler. The closing sentence ('This mutates analysis metadata') largely restates the destructive annotation, so it earns its place less than the two before it.

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

Completeness4/5

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

With no output schema, the description correctly explains that a boolean readback result comes back and warns about its false-negative mode, which is exactly what an agent needs. What remains uncovered - error behavior on malformed addresses - is minor for a two-required-parameter mutation.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3; the description goes beyond it by establishing that an empty comment value is a deletion signal, a semantic the schema's 'Exact analyst comment text to write' does not convey. The hexadecimal address constraint is merely repeated from the schema.

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

Purpose5/5

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

States a specific verb and resource ('Write an inline instruction comment') plus the location type ('hexadecimal address') and the return value ('whether readback matched'). That is concrete enough to separate it from address-name, bookmark, or general comment operations without opening the schema.

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 description supplies one meaningful usage rule - an empty comment clears the existing one - but never states when to prefer this over comment/set_comment siblings, nor any preconditions such as target selection. Usage is inferable rather than guided.

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

Deploy Server

Other Tools