marzban-mcp

List users

marzban_users_list

Read-only

Lists Marzban users with optional status filters and server-side search by username or note; paginate results using limit and offset, and search instead of 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

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

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

Schema Changelog

Changes observed during successful MCP inspections.

Changed20 schema fields changedv0.2.4Oct 23, 2026

removedInput schema / $schema

Removed value: -"https://json-schema.org/draft/2020-12/schema"

removedInput schema / properties / limit / maximum
```
Removed value: -9007199254740991
```
removedInput schema / properties / offset / maximum
```
Removed value: -9007199254740991
```

removedOutput schema / $schema

Removed value: -"https://json-schema.org/draft/2020-12/schema"

changedOutput schema / properties / users / items / properties / admin / anyOf

Previous value: -[
-  {
-    "additionalProperties": false,
-    "properties": {
-      "discord_webhook": {
-        "anyOf": [
-          {
-            "type": "string"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      },
-      "is_sudo": {
-        "type": "boolean"
-      },
-      "telegram_id": {
-        "anyOf": [
-          {
-            "maximum": 9007199254740991,
-            "minimum": -9007199254740991,
-            "type": "integer"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      },
-      "username": {
-        "type": "string"
-      },
-      "users_usage": {
-        "anyOf": [
-          {
-            "maximum": 9007199254740991,
-            "minimum": -9007199254740991,
-            "type": "integer"
-          },
-          {
-            "type": "null"
-          }
-        ]
-      }
-    },
-    "required": [
-      "username",
-      "is_sudo"
-    ],
-    "type": "object"
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "additionalProperties": false,
+    "properties": {
+      "discord_webhook": {
+        "anyOf": [
+          {
+            "type": "string"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "is_sudo": {
+        "type": "boolean"
+      },
+      "telegram_id": {
+        "anyOf": [
+          {
+            "type": "integer"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "username": {
+        "type": "string"
+      },
+      "users_usage": {
+        "anyOf": [
+          {
+            "type": "integer"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      }
+    },
+    "required": [
+      "username",
+      "is_sudo"
+    ],
+    "type": "object"
+  },
+  {
+    "type": "null"
+  }
+]

changedOutput schema / properties / users / items / properties / auto_delete_in_days / anyOf

Previous value: -[
-  {
-    "anyOf": [
-      {
-        "maximum": 9007199254740991,
-        "minimum": -9007199254740991,
-        "type": "integer"
-      },
-      {
-        "type": "null"
-      }
-    ]
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "type": "integer"
+  },
+  {
+    "type": "null"
+  }
+]

changedOutput schema / properties / users / items / properties / data_limit / anyOf

Previous value: -[
-  {
-    "maximum": 9007199254740991,
-    "minimum": -9007199254740991,
-    "type": "integer"
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "type": "integer"
+  },
+  {
+    "type": "null"
+  }
+]

removedOutput schema / properties / users / items / properties / excluded_inbounds / properties
```
Removed value: -{}
```

changedOutput schema / properties / users / items / properties / expire / anyOf

Previous value: -[
-  {
-    "anyOf": [
-      {
-        "maximum": 9007199254740991,
-        "minimum": -9007199254740991,
-        "type": "integer"
-      },
-      {
-        "type": "null"
-      }
-    ]
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "type": "integer"
+  },
+  {
+    "type": "null"
+  }
+]

removedOutput schema / properties / users / items / properties / inbounds / properties
```
Removed value: -{}
```
removedOutput schema / properties / users / items / properties / lifetime_used_traffic / maximum
```
Removed value: -9007199254740991
```
removedOutput schema / properties / users / items / properties / lifetime_used_traffic / minimum
```
Removed value: --9007199254740991
```

changedOutput schema / properties / users / items / properties / next_plan / anyOf

Previous value: -[
-  {
-    "anyOf": [
-      {
-        "additionalProperties": false,
-        "properties": {
-          "add_remaining_traffic": {
-            "default": false,
-            "type": "boolean"
-          },
-          "data_limit": {
-            "anyOf": [
-              {
-                "maximum": 9007199254740991,
-                "minimum": -9007199254740991,
-                "type": "integer"
-              },
-              {
-                "type": "null"
-              }
-            ]
-          },
-          "expire": {
-            "anyOf": [
-              {
-                "maximum": 9007199254740991,
-                "minimum": -9007199254740991,
-                "type": "integer"
-              },
-              {
-                "type": "null"
-              }
-            ]
-          },
-          "fire_on_either": {
-            "default": true,
-            "type": "boolean"
-          }
-        },
-        "type": "object"
-      },
-      {
-        "type": "null"
-      }
-    ]
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "additionalProperties": false,
+    "properties": {
+      "add_remaining_traffic": {
+        "default": false,
+        "type": "boolean"
+      },
+      "data_limit": {
+        "anyOf": [
+          {
+            "type": "integer"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "expire": {
+        "anyOf": [
+          {
+            "type": "integer"
+          },
+          {
+            "type": "null"
+          }
+        ]
+      },
+      "fire_on_either": {
+        "default": true,
+        "type": "boolean"
+      }
+    },
+    "type": "object"
+  },
+  {
+    "type": "null"
+  }
+]

changedOutput schema / properties / users / items / properties / note / anyOf

Previous value: -[
-  {
-    "anyOf": [
-      {
-        "type": "string"
-      },
-      {
-        "type": "null"
-      }
-    ]
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "type": "string"
+  },
+  {
+    "type": "null"
+  }
+]

changedOutput schema / properties / users / items / properties / on_hold_expire_duration / anyOf

Previous value: -[
-  {
-    "anyOf": [
-      {
-        "maximum": 9007199254740991,
-        "minimum": -9007199254740991,
-        "type": "integer"
-      },
-      {
-        "type": "null"
-      }
-    ]
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "type": "integer"
+  },
+  {
+    "type": "null"
+  }
+]

removedOutput schema / properties / users / items / properties / proxies / additionalProperties / properties
```
Removed value: -{}
```
removedOutput schema / properties / users / items / properties / proxies / properties
```
Removed value: -{}
```

changedOutput schema / properties / users / items / properties / sub_last_user_agent / anyOf

Previous value: -[
-  {
-    "anyOf": [
-      {
-        "type": "string"
-      },
-      {
-        "type": "null"
-      }
-    ]
-  },
-  {
-    "type": "null"
-  }
-]New value: +[
+  {
+    "type": "string"
+  },
+  {
+    "type": "null"
+  }
+]

removedOutput schema / properties / users / items / properties / used_traffic / maximum
```
Removed value: -9007199254740991
```
removedOutput schema / properties / users / items / properties / used_traffic / minimum
```
Removed value: --9007199254740991
```

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.2/5.0

Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered by structured data. The description adds pagination economics (default 25, max 100) and the recommendation to search rather than page, which is genuinely useful behavioral context, but it says nothing about ordering, whether a total count is returned, or what happens at the end of a page.

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 short sentences, front-loaded with the core action, then pagination constraint, then the routing advice. No filler or restated title.

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?

A read-only list tool with an output schema and only four optional parameters needs little more; the description covers filtering, pagination limits, and tool selection. The only real gap is offset/paging mechanics, which the agent must infer when a result set exceeds the page size.

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%, and the description largely restates what the schema already documents for `limit` (default 25, max 100) and `search` (username/note matching). It adds only that filtering is possible by status; `offset` is never explained in either place, and the status enum values carry no guidance. Adequate but not compensating for the coverage gap.

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 specific verb and resource ('Lists users') plus the two supported filters, and explicitly distinguishes itself from marzban_users_get for single-user lookup. An agent can select this over its siblings without opening any schema.

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?

Gives positive guidance ('prefer `search` over paging through everyone') and an explicit alternative with its trigger condition ('For one known username, use marzban_users_get instead'). This is exactly the when/when-not/alternative structure that removes inference.

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

Deploy Server