Skip to main content
Glama

Inline Comment

inline_comment
Idempotent

Reads the inline instruction comment at a specified address or current cursor and returns null when none exists, so you can inspect annotations before writing with set_inline_comment.

Instructions

Read the inline instruction comment at an address, defaulting to the current cursor. Returns null when absent; use set_inline_comment to write one.

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": "inline_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

A3.8/5.0
Behavior2/5

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

The description frames this as a pure read that returns null when no comment exists, yet the annotations set readOnlyHint=false, which is at odds with that framing. The harm is limited because destructiveHint=false and idempotentHint=true, but the mismatch means the agent gets conflicting signals about whether calling this can change state, and nothing else behavioral (e.g. what a non-null return looks like) is disclosed.

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 short sentences, front-loaded with the action and scope, followed by return behavior and the write alternative. There is no redundant restatement of the name or title.

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 lookup with no output schema, the description covers the default-value behavior and the null case, which is enough to call it correctly. It leaves the shape of a successful (non-null) return implicit and does not resolve the read-only ambiguity introduced by 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 coverage is 100%, so both optional parameters (address, document) are already fully documented, including the hex-address convention and open_binary for switching targets. The description only adds that address defaults to "the current cursor," which is useful but marginal against the schema's own coverage.

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?

The description uses a specific verb and resource ("Read the inline instruction comment") and scopes it ("at an address, defaulting to the current cursor"). It explicitly distinguishes itself from the write sibling set_inline_comment, so an agent can tell the reader from the writer without opening either schema.

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 use condition (read an inline comment, with the cursor default) and names the correct alternative for the opposite operation: "use set_inline_comment to write one." It stops short of stating exclusions, such as how this differs from the nearby generic comment/set_comment siblings, so it is strong but not a full routing guide.

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