Skip to main content
Glama

set_client_alias

Assign a friendly name to a client device by its MAC address to override the hostname in UniFi Network Controller.

Instructions

Set the friendly name (alias) on a client by MAC. This is the UniFi "name" field that overrides hostname.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
macYesClient MAC address
nameYesFriendly name to assign

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A3.8/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full behavioral burden. It adds one genuinely useful behavioral detail — that this field overrides hostname — but does not disclose what happens to an existing alias, whether the MAC must exist, idempotency, or permission requirements. It exceeds a bare statement of mutation but does not fully compensate for the missing annotations.

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?

Two sentences with zero filler. The first sentence front-loads the action and target; the second adds the essential semantic clarification. Every word earns its place.

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

Completeness4/5

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

For a simple two-parameter setter with no output schema, the description covers what it does, how it identifies the client, and the field's behavioral effect. It could optionally mention that it replaces any existing alias or note error behavior when the MAC is unknown, but these are minor gaps for a tool of this complexity.

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?

Schema description coverage is 100%, so the schema already documents both parameters adequately. The description adds marginal value by explaining that 'name' is the UniFi name field with hostname-overriding behavior, which enriches the name parameter's meaning, but it does not add format, constraints, or selection guidance beyond the schema.

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 a specific verb and resource ('Set the friendly name (alias) on a client by MAC') and clarifies the semantic distinction from the hostname. This clearly differentiates it from siblings like set_client_note and set_client_user_group without needing to inspect schemas.

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

Usage Guidelines3/5

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

The context for when to use this tool is implied via the field semantics ('overrides hostname'), which hints at the display-naming use case. However, there is no explicit when-to-use guidance, no exclusions, and no routing to closely related siblings like set_client_note or set_client_user_group.

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