Skip to main content
Glama
Sign In
UniFi MCP

UniFi MCP

by frousselet
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

protect_get_viewer

Retrieve detailed information about a UniFi Protect viewer using its viewer ID. Provides comprehensive viewer details for monitoring and management.

Instructions

Get detailed information about a specific Protect viewer.

Args: viewer_id: The viewer ID.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "viewer_id": "<viewer_id>"
    },
    "name": "protect_get_viewer"
  }
}

Input Schema

NameRequiredDescriptionDefault
viewer_idYes

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.4/5.0
Behavior2/5

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

With no annotations, the description carries full burden but only states 'Get detailed information', which implies a read operation. No disclosure of idempotency, rate limits, or dependency on viewer existence beyond the schema.

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

Conciseness3/5

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

The description is extremely short (one sentence plus an args line), which is concise but sacrifices explanatory value. It is not verbose but also not informative.

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

Completeness2/5

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

Given the tool has one required parameter and an output schema, the description is minimal. It does not explain what a viewer is, provide examples, or clarify the return structure beyond the schema.

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%, and the description merely repeats the parameter name as 'The viewer ID', adding no meaning beyond the schema's title 'Viewer Id'. This is tautological.

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

Purpose4/5

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

The description clearly states the verb 'Get' and resource 'Protect viewer', making it distinct from sibling tools like protect_get_camera or network_get_device. However, it does not elaborate on what 'detailed information' includes, which could be clarified.

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

Usage Guidelines2/5

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

No guidance is provided on when to use this tool versus alternatives (e.g., protect_list_viewers or protect_update_viewer). The description omits context like prerequisites or typical use cases.

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