Skip to main content
Glama

Comment

comment
Idempotent

Read the analysis comment stored at a given address, defaulting to the current cursor. Returns null when none exists; use to check findings before persisting them.

Instructions

Read the regular analysis comment at an address, defaulting to the current cursor. This is read-only and returns null when no comment exists; use set_comment to persist a finding.

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": {},
    "name": "comment"
  }
}

Input Schema

NameRequiredDescriptionDefault
addressNoA provider-normalized address; default memory uses 0x-prefixed hexadecimal
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

B3.4/5.0
Behavior1/5

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

The description asserts "This is read-only," while the annotations explicitly declare readOnlyHint=false. That is a direct conflict about whether the call mutates state. Useful details such as returning null when no comment exists are present, but the read-only claim undermines the agent's ability to trust the safety profile.

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?

Two compact sentences, front-loading what is read and where, followed by return behavior and the alternative. No filler or redundant restatement of the tool name.

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 two-optional-parameter read tool with no output schema, the description covers the key behaviors: the default target, the null return, and the write alternative. The one missing element is trustworthy mutation semantics, since the read-only claim conflicts with the annotations.

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 both the address and document parameters are already documented in the schema, which sets the baseline at 3. The description adds one genuine piece of semantics, namely that the address defaults to the current cursor, but it says nothing about how the two parameters interact or when to pass document.

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?

"Read the regular analysis comment at an address" gives a specific verb (read) and a specific resource (the regular analysis comment), which resolves the ambiguity of the bare tool name "comment". The word "regular" implicitly contrasts with the inline-comment siblings, but it never names inline_comment explicitly, so the differentiation is inferred rather than stated.

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?

The description names the write counterpart directly ("use set_comment to persist a finding"), which is the key routing decision for a read tool. It does not mention the inline-comment variants or state when this tool should not be used, leaving some sibling disambiguation to the agent.

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