UniFi Protect MCP

by owine

Overview Schema Source Related Servers Discussions Admin

TypeScript

Remote

List users

protect_list_users

Read-only

List UniFi Protect users available to the current API key, with optional limit and offset for paging large sites.

Instructions

List all Protect users (filtered by the API key's access permissions). Returns array; each user includes (Integration API 7.3.70-verified): id, modelKey, name, firstName, lastName, email, ucoreUserId. The Integration API does NOT expose roles, permissions, login history, groups, or notification settings. On a large site, use limit and offset to page; a paged result also returns totalCount and offset.

Input Schema

TableJSON Schema

Name	Required	Description	Default
`limit`	No	Return at most this many items
`offset`	No	Skip this many items first (default 0)

Output Schema

TableJSON Schema

Name	Required	Description
`offset`	No	Paged results only: the index of the first item returned
`result`	Yes	Array of items returned by the list endpoint
`totalCount`	No	Paged results only: the number of items in the whole list

Schema Changelog

Changes observed during successful MCP inspections.

Changed6 schema fields changedv2.15.0Oct 14, 2026

addedInput schema / $schema

Added value: +"http://json-schema.org/draft-07/schema#"

addedInput schema / properties / limit

Added value: +{
+  "description": "Return at most this many items",
+  "maximum": 9007199254740991,
+  "minimum": 1,
+  "type": "integer"
+}

addedInput schema / properties / offset

Added value: +{
+  "description": "Skip this many items first (default 0)",
+  "maximum": 9007199254740991,
+  "minimum": 0,
+  "type": "integer"
+}

changedOutput schema / additionalProperties
```
Previous value: -falseNew value: +{}
```

addedOutput schema / properties / offset

Added value: +{
+  "description": "Paged results only: the index of the first item returned",
+  "maximum": 9007199254740991,
+  "minimum": -9007199254740991,
+  "type": "integer"
+}

addedOutput schema / properties / totalCount

Added value: +{
+  "description": "Paged results only: the number of items in the whole list",
+  "maximum": 9007199254740991,
+  "minimum": -9007199254740991,
+  "type": "integer"
+}

Changed12 schema fields changedv2.11.5Sep 13, 2026
- removedOutput schema / properties / result / items / properties / email / anyOf
```
Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]
```
- addedOutput schema / properties / result / items / properties / email / type
```
Added value: +[
+  "string",
+  "null"
+]
```
- removedOutput schema / properties / result / items / properties / firstName / anyOf
```
Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]
```
- addedOutput schema / properties / result / items / properties / firstName / type
```
Added value: +[
+  "string",
+  "null"
+]
```
- removedOutput schema / properties / result / items / properties / lastName / anyOf
```
Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]
```
- addedOutput schema / properties / result / items / properties / lastName / type
```
Added value: +[
+  "string",
+  "null"
+]
```
- removedOutput schema / properties / result / items / properties / modelKey / anyOf
```
Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]
```
- addedOutput schema / properties / result / items / properties / modelKey / type
```
Added value: +[
+  "string",
+  "null"
+]
```
- removedOutput schema / properties / result / items / properties / name / anyOf
```
Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]
```
- addedOutput schema / properties / result / items / properties / name / type
```
Added value: +[
+  "string",
+  "null"
+]
```
- removedOutput schema / properties / result / items / properties / ucoreUserId / anyOf
```
Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]
```
- addedOutput schema / properties / result / items / properties / ucoreUserId / type
```
Added value: +[
+  "string",
+  "null"
+]
```
First observedv2.7.4Jun 11, 2026

TDQS

A3.8/5.0

Behavior4/5

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

Annotations already establish this as a safe read (readOnlyHint=true, destructiveHint=false, openWorldHint=false), but the description goes further by enumerating the returned fields and, more valuably, explicitly listing what the Integration API does NOT expose (roles, permissions, login history, groups, notification settings). It also discloses the paging shape (totalCount, offset returned for paged results), which prevents futile calls.

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?

Purpose is front-loaded, followed by returned fields, exclusions, then paging advice, so a reader can stop early. Most sentences earn their place, though the parenthetical '7.3.70-verified' provenance tag is slightly noise for an agent selecting a tool.

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?

An output schema exists, so return shape need not be spelled out, yet the description still summarizes returned fields and explicit exclusions, plus paging semantics. The only meaningful gap is no routing guidance against the closely named sibling protect_list_ulp_users.

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?

Schema description coverage is 100%, so both limit and offset are already fully documented, setting the baseline at 3. The description adds value by tying them to a concrete scenario ('on a large site') and explaining what paging changes in the response (totalCount, offset), which the schema alone does not convey.

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?

States a specific verb+resource ('List all Protect users') and adds the scoping caveat that results are filtered by the API key's access permissions. However, with siblings like protect_list_ulp_users and protect_get_user in the set, it never distinguishes which user population or granularity it covers, leaving that disambiguation to the agent.

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 description gives one concrete usage cue ('On a large site, use limit and offset to page'), which is real guidance, but there is no when-to-use vs when-not guidance relative to protect_list_ulp_users or protect_get_user. Usage is implied rather than stated.

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