UniFi Protect MCP

Overview Schema Source Related Servers Discussions Admin

List ULP users

protect_list_ulp_users

Read-only

List UniFi Identity (ULP) users with enrolled credentials, including NFC cards or fingerprints, and page large result sets using limit and offset.

Instructions

List UniFi Identity (ULP) users — per the API docs, those with enrolled credentials (NFC cards, fingerprints). Returns array; each ULP user includes (Integration API 7.3.70-verified): id, modelKey, firstName, lastName, fullName, email (empty string for service accounts), status (e.g. ACTIVE). Enrolled-credential detail (NFC cards, fingerprints) is NOT exposed by this API surface. 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.

Changed7 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"
+}

changedOutput schema / properties / result / items / properties / email / description

Previous value: -"Email address, added in 7.3.x. Empty string for service accounts (verified live 7.3.47)"New value: +"Email address, added in 7.3.x. Empty string for service accounts (verified live 7.3.70)"

addedOutput schema / properties / totalCount

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

Changed1 schema field changedv2.13.0Sep 20, 2026

addedOutput schema / properties / result / items / properties / email

Added value: +{
+  "description": "Email address, added in 7.3.x. Empty string for service accounts (verified live 7.3.47)",
+  "type": [
+    "string",
+    "null"
+  ]
+}

Changed10 schema fields changedv2.11.5Sep 13, 2026
- 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 / fullName / anyOf
```
Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]
```
- addedOutput schema / properties / result / items / properties / fullName / 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 / status / anyOf
```
Removed value: -[
-  {
-    "type": "string"
-  },
-  {
-    "type": "null"
-  }
-]
```
- addedOutput schema / properties / result / items / properties / status / 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 declare readOnlyHint=true, destructiveHint=false and openWorldHint=false, so safety is covered. The description adds genuinely useful behavioral context beyond that: the scope limitation that enrolled-credential detail (NFC cards, fingerprints) is NOT exposed, and that paged responses also carry totalCount and offset.

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?

Front-loaded with the core purpose and scope definition, then return shape, then paging. Dense but every sentence carries information; the inline field enumeration and API-version parentheticals are slightly heavy but justified for a schema-verified contract.

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?

With an output schema present, the description need not enumerate return fields, but it does note the empty-string email for service accounts and the enrolled-credential limitation — the two things an agent would otherwise get wrong. The only real gap is not routing the agent away from protect_list_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?

The schema documents both parameters fully (100% coverage), so the baseline is 3. The description earns above baseline by explaining the operational purpose of limit/offset (paging a large site) and that paging changes the response envelope to include totalCount and offset.

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 and resource and goes further by defining what a ULP user is (UniFi Identity users with enrolled credentials), which implicitly separates this list from protect_list_users. However, it never names that sibling, so an agent choosing between the two lists still has to infer the distinction.

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?

Gives one concrete usage condition — page with limit/offset on a large site — but offers no when-to-use vs alternatives guidance and does not mention protect_list_users or protect_get_ulp_user. Usage is implied by the definition rather than stated.

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