Skip to main content
Glama
Sign In
MCP-TrueNAS

MCP-TrueNAS

by PainInTheNic
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

List Services

truenas_list_services
Read-only

List TrueNAS services (SMB, NFS, SSH, iSCSI) with running state and boot-start setting. Filter by state and choose markdown or JSON.

Instructions

List TrueNAS services (SMB, NFS, SSH, iSCSI, ...) with running state and whether they start on boot.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "truenas_list_services"
  }
}

Input Schema

NameRequiredDescriptionDefault
stateNoOnly services in this state
response_formatNomarkdown = compact human-readable summary; json = full structured datamarkdown

Output Schema

NameRequiredDescriptionDefault
countYes
servicesYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.1/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, so the agent knows it is safe. The description adds that it returns running state and boot-start status, which is useful but does not disclose deeper behaviors like filtering or pagination; this matches the baseline for annotation-covered tools.

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 a single, front-loaded sentence with no filler. It efficiently communicates the tool's purpose and key output fields.

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

Completeness5/5

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

For a simple read-only list tool with good annotations, an output schema, and fully documented parameters, the description is sufficient. It conveys the domain and output, while schema and annotations cover the remaining details.

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?

The input schema already provides 100% coverage with descriptions for both parameters (state and response_format), including enums and defaults. The description adds no extra meaning about parameters, so the baseline 3 applies.

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 the specific verb 'List' and identifies the resource as 'TrueNAS services' with examples (SMB, NFS, SSH, iSCSI), clearly distinguishing it from sibling list tools. It also states the output includes running state and boot-start status, making the purpose unambiguous.

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?

The description provides clear context that this tool is for listing services, and the examples indicate which kind of services, but it does not explicitly mention alternatives or when-not-to-use it. Since the scope is self-evident and no exclusions are stated, it earns a 4 rather than a 5.

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