Skip to main content
Glama

Set Comment

set_comment
DestructiveIdempotent

Write or clear a regular analysis comment at a hexadecimal address, verify readback, and record evidence IDs or reasoning in the active Hopper document.

Instructions

Write a regular analysis comment at a hexadecimal address and return whether readback matched. An empty comment clears it. This mutates the Hopper document; use comments to record evidence IDs or reasoning.

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": "validated entry point"
    },
    "name": "set_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 declare that this mutates, is destructive, and is idempotent. The description adds useful behavior beyond that: it returns whether readback matched and an empty comment clears the existing comment. It does not discuss permissions or side effects on other document state.

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

Conciseness5/5

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

Three short sentences, front-loaded with the core action and followed by clearing behavior and mutation context. Every sentence adds useful information without repetition.

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?

For a mutation tool with rich annotations and full schema coverage, the description covers the key behavioral points: mutation, clearing, readback verification, and intended use. No output schema exists, but the readback result is described sufficiently.

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 schema already documents address, comment, and document parameters. The description adds meaning beyond the schema by explaining that an empty comment clears the comment and by reinforcing the hexadecimal address context.

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 states a specific verb and resource: write a regular analysis comment at a hexadecimal address, with readback verification and empty-comment clearing. It is clear what the tool does, though it does not explicitly distinguish itself from sibling comment tools such as set_inline_comment.

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

Usage Guidelines4/5

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

It gives a clear usage context: use comments to record evidence IDs or reasoning. It does not state when not to use this tool or name an alternative for inline comments, so it stops short of full routing guidance.

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