opnsense_kea_subnet_get

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

No annotations are provided, so the description must convey all behavioral traits. It states 'get detailed configuration', which implies a read-only operation, but it does not elaborate on the output structure, potential errors, or any side effects. This is adequate but minimal for a simple retrieval tool.

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?

The description is a single sentence, extremely concise, and front-loaded with the key information. No unnecessary words.

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?

Given the simplicity of the tool (one parameter, no output schema), the description is complete enough for an agent to understand its purpose. It could optionally mention the type of configuration details returned, but the current level is sufficient for a basic get operation.

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?

The input schema has 100% description coverage for the single parameter 'uuid', with a basic description 'Subnet UUID'. The tool description does not add any additional meaning or formatting guidance beyond what the schema already provides, so it remains at the baseline score.

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?

The description clearly states the action 'Get detailed configuration', the specific resource 'Kea DHCPv4 subnet', and the identifier method 'by UUID'. It effectively distinguishes from sibling tools like opnsense_kea_subnet_list (which lists all subnets) and opnsense_kea_subnet_create/update/delete, 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.

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

The description implies usage when you have a UUID and need detailed config, but it does not explicitly state when to use this tool versus alternatives, nor does it mention any prerequisites or exclusions. There is no guidance on when not to use it.

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