Skip to main content
Glama

dataset_get

Read-only

Retrieve full details for a single TrueNAS dataset using its dataset ID, such as 'tank/data', to inspect configuration and properties.

Instructions

[READ] Return detail for a single dataset by id (e.g. 'tank/data').

Args: dataset_id: TrueNAS dataset id (see dataset_list). target: TrueNAS target name from config.

Input Schema

NameRequiredDescriptionDefault
targetNo
dataset_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/5

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

The '[READ]' prefix is consistent with readOnlyHint=true and adds a small amount of clarity, but it largely restates the annotation. Beyond safety it discloses nothing about behavior — no indication of what 'detail' includes, whether the id must exactly match, or what happens when the dataset is missing.

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?

Compact and front-loaded: the one-line purpose precedes the parameter notes, and there is no filler. Slightly under-specified rather than wordy, so it earns its length.

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

Completeness3/5

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

For a simple read of one record with no output schema and only two params, the essentials are present. Still missing: what the returned detail comprises, whether target is required when multiple targets are configured, and failure behavior — meaningful gaps for an agent that must call it correctly.

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 0%, so the description must carry parameter meaning, and it does document both params: dataset_id as a TrueNAS dataset id with an example and a pointer to dataset_list, and target as a TrueNAS target name from config. The target description is thin (where in config? optional?) and no format/validation detail is given for dataset_id, so it compensates only partially.

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?

'Return detail for a single dataset by id' gives a specific verb (return/get) and resource (single dataset), with an example id ('tank/data'). It implicitly differentiates from dataset_list by saying 'single', though it never states the contrast outright.

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

Usage Guidelines3/5

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

The parenthetical '(see dataset_list)' routes the agent to the sibling for enumerating datasets, which implies this tool is for fetching one known dataset. However, there is no explicit when-to-use statement, no prerequisite (e.g. must the dataset exist / must target be configured), and no exclusions.

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