Skip to main content
Glama

DebugCreateMemorySnapshot

Writes a memory snapshot of a stopped debuggee and returns the file path, so you can inspect debug state outside batch mode.

Instructions

[read-only] [debug] Writes a memory snapshot of the stopped debuggee and answers the file written. Runs outside batch mode.

Input Schema

NameRequiredDescriptionDefault
detailNoHow much of the answer to return: "terse" (default, the fields you need to act), "full" (the whole parse), "raw" (the document as ADT sent it).terse
state_handleYesOpaque handle identifying the server-held state this operation works on.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv20.1.0

TDQS

A3.6/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the full burden. It does disclose the key side effect (a file is written and its path is returned) and the batch-mode restriction, but says nothing about where the file lands, its size/overhead, or whether the debuggee state is otherwise untouched despite the "[read-only]" tag.

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 clauses, with the mode tags and the core action front-loaded; nothing is wasted. The bracket tags are a minor stylistic cost rather than padding.

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-parameter debug utility with no output schema, the description covers the action, the returned artifact, and the execution-mode constraint. Remaining gaps (file location, cleanup) are small relative to the tool's simplicity.

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%, including a documented enum for `detail`, so the schema already does the explanatory work. The description adds no meaning about `state_handle` or the detail levels, making the baseline 3 correct.

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?

States a specific verb and resource: writes a memory snapshot of the stopped debuggee and returns the file written. It is clearly distinguishable from the read-side siblings (MemorySnapshotGet/List/Delta), though it never names them explicitly.

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?

"of the stopped debuggee" gives the precondition (a stopped debug session) and "Runs outside batch mode" gives an explicit when-not constraint, which usefully separates it from the DebugBatch* tools. It stops short of naming alternatives such as MemorySnapshotList or MemorySnapshotGet.

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