Skip to main content
Glama

unifi_gen_getnetworkdetails

unifi_gen_getnetworkdetails
Read-onlyIdempotent

Retrieves detailed information for a specific UniFi network using its UUID, enabling configuration review and troubleshooting.

Instructions

Get Network Details - generated from developer.ui.com/network/v11.0.97/getnetworkdetails

Input Schema

NameRequiredDescriptionDefault
networkIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.4.0

TDQS

D1.6/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=true, so the safety profile is covered without the description. The description adds nothing about what a 'network detail' contains, error behavior for invalid/unknown IDs, or permissions — the 'generated from developer.ui.com/.../v11.0.97/getnetworkdetails' note only signals the upstream API version.

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

Conciseness2/5

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

It is short, but shortness here is under-specification rather than concision; the only content beyond the title is a provenance URL. Nothing is front-loaded because there is nothing substantive to front-load.

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

Completeness1/5

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

A detail-fetch tool with a required identifier and no output schema needs the description to explain what is returned and how it differs from other network getters. Nothing of the sort is present, leaving the agent unable to predict the response shape or pick correctly among siblings.

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

Parameters1/5

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

Schema description coverage is 0%, so the description carries the full burden of explaining the single parameter, yet it says nothing. An agent must infer that networkId is the UUID of a UniFi network, and specifically which network identifier (site-scoped? overlay? VLAN?) is expected.

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

Purpose2/5

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

The description restates the name ('Get Network Details') with no elaboration, which is effectively a tautology. It gives no way to distinguish this from close siblings such as unifi_net_get_network, unifi_gen_getnetworkreferences, or unifi_gen_getnetworksoverviewpage, which all sound like they return network details.

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

Usage Guidelines1/5

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

There is no guidance on when to use this tool versus the many sibling getters, no preconditions, and no exclusions. The only additional text is a source URL for the upstream API spec, which is not usage instruction.

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