service_list

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

[READ] tag indicates read-only operation. Lists returned fields. No annotations present, so description carries burden; it adequately conveys safe behavior, but lacks details on error handling or limitations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Is the description appropriately sized, front-loaded, and free of redundancy?

Two lines, front-loaded with purpose and [READ] tag. No unnecessary words; parameter explanation concise.

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

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

Mentions returned fields, no output schema. Lacks details on ordering, pagination, or maximum results, but for system services list it is likely sufficient.

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

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

Single parameter 'target' explained: 'TrueNAS target name from config; omit to use the default.' Provides context beyond schema (source, default behavior). Schema coverage 0% but description compensates fully.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Does the description clearly state what the tool does and how it differs from similar tools?

Description clearly states 'List system services' with specific fields (name, state, enable). Distinguishes from sibling tools like service_restart and other list tools.

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

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

Implied usage: omit target for default. No explicit when-to-use or alternatives comparison with siblings, but adequate for a simple list.

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