Skip to main content
Glama
jaseonline

unifi-console-mcp

by jaseonline

unifi_console_access_review

Read-onlyIdempotent

Audit UniFi console access by retrieving admin accounts, custom roles, and masked API keys to support least-privilege reviews of integration accounts.

Instructions

Who and what can access the console: admin accounts, custom roles and API keys (keys masked).

Useful for least-privilege reviews of integration accounts. Needs read access to UniFi OS users. Returns JSON: {"ok", "data": {"admins": [...], "roles": [...], "api_keys": [...]}}.

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare read-only, idempotent, non-destructive behavior, so the bar is lower. The description adds genuine context beyond them: API keys are masked, and read access to UniFi OS users is required. It does not discuss rate limits or pagination, but nothing material is hidden.

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

Conciseness4/5

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

Three short sentences, purpose front-loaded before caveats. The trailing 'Returns JSON: {...}' block restates what the output schema already defines, so it is mildly redundant, but it is compact and does no real harm.

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?

A zero-parameter, read-only tool with full annotation coverage and an output schema needs little prose. The description supplies purpose, use case, permission prerequisite, and a data-sensitivity note (masked keys) – everything an agent needs to call it correctly.

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

Parameters4/5

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

The tool takes zero parameters, so the baseline is 4 and there is nothing for the description to disambiguate. The description correctly spends no effort on parameters.

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?

States a precise scope verb+resource ('Who and what can access the console') and enumerates the three data domains returned (admin accounts, custom roles, API keys). No sibling tool covers access review, so the agent can distinguish it immediately from console/client/network siblings.

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?

Gives clear context for use ('useful for least-privilege reviews of integration accounts') and a prerequisite ('Needs read access to UniFi OS users'). It stops short of explicit when-not guidance or naming an alternative, but no sibling competes for this purpose, so the gap is minor.

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