Skip to main content
Glama
Sign In
TrueNAS Core MCP Server

TrueNAS Core MCP Server

by vespo92
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

get_dataset_properties

Retrieve all properties of a specified dataset on TrueNAS Core, including details like path, usage, permissions, and more for effective storage management and monitoring.

Instructions

Get all properties of a dataset

Args:
    dataset: Dataset path (e.g., "tank/data")

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "dataset": "<dataset>"
    },
    "name": "get_dataset_properties"
  }
}

Input Schema

NameRequiredDescriptionDefault
datasetYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

B3.1/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It states 'Get all properties' but doesn't clarify what 'properties' include (e.g., metadata, settings), whether it's a read-only operation, or any constraints like permissions required. This leaves significant gaps in understanding the tool's behavior.

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?

The description is highly concise and well-structured, with a clear purpose statement followed by a parameter explanation in a bullet-like format. Every sentence adds value without redundancy, making it easy to parse quickly.

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?

Given the lack of annotations and output schema, the description is incomplete. It doesn't explain what 'properties' are returned or any behavioral traits like error handling. For a tool with no structured metadata, more detail is needed to fully understand its use and output.

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

Parameters4/5

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

The description adds meaningful context for the single parameter 'dataset' by providing an example ('tank/data'), which clarifies the expected format. Since schema description coverage is 0%, this compensates well, though it could be more detailed about path conventions or restrictions.

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?

The description clearly states the tool's purpose with a specific verb ('Get') and resource ('properties of a dataset'), making it immediately understandable. However, it doesn't differentiate from sibling tools like 'get_dataset_permissions' or 'modify_dataset_properties', which would require more specificity about what 'properties' encompasses.

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?

The description provides no guidance on when to use this tool versus alternatives. With siblings like 'list_datasets' (for listing datasets) and 'get_dataset_permissions' (for permissions), there's no indication of when this tool is appropriate, such as for retrieving metadata versus other dataset-related operations.

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

Related Tools