marzban-mcp

List users

marzban_users_list

Read-only

Retrieve paginated Marzban users with optional filters by status or search term matching username or note. Use search to avoid paging through all users.

Instructions

Lists users, optionally filtered by status or a search term (matches username/note). Paginated — default 25, max 100 per call; prefer search over paging through everyone. For one known username, use marzban_users_get instead.

Input Schema

TableJSON Schema

Name	Required	Description
`limit`	No	Default 25, max 100.
`offset`	No
`search`	No	Matches username or note (server-side substring search).
`status`	No

Output Schema

TableJSON Schema

Name	Required	Description	Default
`note`	Yes
`total`	Yes
`users`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

Changed5 schema fields changedv0.2.3Sep 7, 2026

removedOutput schema / properties / users / items / properties / created_at / format
```
Removed value: -"date-time"
```

removedOutput schema / properties / users / items / properties / created_at / pattern

Removed value: -"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|))$"

changedOutput schema / properties / users / items / properties / on_hold_timeout / anyOf

Previous value: -[
-  {
-    "anyOf": [
-      {
-        "format": "date-time",
-        "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|))$",
-        "type": "string"
-      },
-      {
-        "type": "null"
-      }
-    ]
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "type": "string"
+  },
+  {
+    "type": "null"
+  }
+]

changedOutput schema / properties / users / items / properties / online_at / anyOf

Previous value: -[
-  {
-    "anyOf": [
-      {
-        "format": "date-time",
-        "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|))$",
-        "type": "string"
-      },
-      {
-        "type": "null"
-      }
-    ]
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "type": "string"
+  },
+  {
+    "type": "null"
+  }
+]

changedOutput schema / properties / users / items / properties / sub_updated_at / anyOf

Previous value: -[
-  {
-    "anyOf": [
-      {
-        "format": "date-time",
-        "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|))$",
-        "type": "string"
-      },
-      {
-        "type": "null"
-      }
-    ]
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "type": "string"
+  },
+  {
+    "type": "null"
+  }
+]

First observedv0.2.2Sep 2, 2026

TDQS

A4.5/5.0

Behavior4/5

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

Annotations already cover readOnlyHint=true and destructiveHint=false. The description adds pagination defaults (25, max 100) and clarifies that search matches username/note, which is beyond the annotations. It does not detail the response envelope or error behavior, but the output schema exists, so a 4 is appropriate.

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?

Three sentences with zero filler: purpose, filter options, pagination limits, and routing to the sibling. The most critical information (what the tool lists and its filters) is front-loaded, and every clause contributes.

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?

For a read-only list tool with an output schema, annotations covering safety, and clear sibling differentiation, the description supplies all needed operational context: filtering, pagination, and search guidance. Nothing an agent needs to invoke it correctly is missing.

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 coverage is 50% (limit and search have descriptions). The description reinforces these and adds the pagination preference, but it adds little for offset (no semantics) and status (only says 'optionally filtered', enum is in schema). It partially compensates for the coverage gap but does not fully explain each parameter's role.

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 opens with a clear verb+resource ('Lists users') and immediately specifies the filtering options (status, search term). It explicitly differentiates from the sibling marzban_users_get by noting the single-user alternative, so an agent can reliably pick the right tool without opening schemas.

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

Usage Guidelines5/5

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

It gives concrete guidance on when to prefer search over paging ('prefer `search` over paging through everyone') and names the exact alternative for a known username ('use marzban_users_get instead'). This is explicit when-to-use and when-not-to-use guidance with a sibling reference.

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

Deploy Server