Skip to main content
Glama

registry_key

Read Windows registry hives to inspect a key's values, last-write time, and subkeys up to depth 4 for forensic analysis.

Instructions

Read a Windows registry hive (SYSTEM, SOFTWARE, SAM, NTUSER.DAT, UsrClass.dat, Amcache.hve): a key's values, last-write time and subkeys to depth (max 4).

Input Schema

NameRequiredDescriptionDefault
keyNo
refNo
partNo
depthNo
imageNo
local_pathNo
max_valuesNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.7/5.0
Behavior2/5

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

With no annotations, the description carries the full burden of behavioral disclosure. It does reveal output content and a depth cap of 4, but says nothing about how a hive is sourced (image vs local_path vs ref/part), permission requirements, error behavior when a key is absent, or truncation via max_values.

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?

A single well-formed sentence with the read scope and hive list front-loaded and no filler. It is efficient, though the brevity is partly under-specification rather than tight editing.

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

Completeness2/5

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

For a 7-parameter, 0%-schema-coverage tool with no annotations and no output schema, the description omits too much: the hive-source mechanism, the role of ref/part, and the max_values cap are all unexplained, so an agent cannot confidently construct a valid call.

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

Parameters2/5

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

Schema description coverage is 0% across 7 parameters, so the description must compensate and largely does not. It gives meaning only to 'depth' (max 4) and implicitly to 'key'; the critical image/local_path/ref/part source-selection parameters and max_values go undefined anywhere.

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 ('Read') and resource (a Windows registry hive), enumerates the hive types (SYSTEM, SOFTWARE, SAM, NTUSER.DAT, UsrClass.dat, Amcache.hve) and names the returned artifacts (values, last-write time, subkeys). It does not explicitly distinguish itself from the sibling registry_plugins, so it falls just short of 5.

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

Usage Guidelines2/5

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

No guidance on when to reach for this tool versus registry_plugins or the generic read/stat/extract tools. It never explains which hive should be paired with which of image/local_path/ref/part, leaving selection entirely to inference.

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