marzban-mcp

Put user on hold

marzban_users_hold

Set a user's status to on_hold so accounts can be provisioned ahead of time without starting their expiry timer until first connection.

Instructions

Sets a user's status to on_hold — inactive until their first connection, at which point the on-hold timer starts. Useful for provisioning an account ahead of time without starting its clock.

Input Schema

Name	Required	Description	Default
`username`	Yes
`onHoldExpireDuration`	No	Seconds the user may stay on_hold before expiring, counted from their first connection.

Output Schema

Name	Required	Description	Default
`note`	No
`admin`	No
`links`	No
`expire`	No
`status`	Yes
`proxies`	Yes
`inbounds`	No
`username`	Yes
`next_plan`	No
`online_at`	No
`created_at`	Yes
`data_limit`	No	data_limit can be 0 or greater
`used_traffic`	Yes
`sub_updated_at`	No
`on_hold_timeout`	No
`subscription_url`	No
`excluded_inbounds`	No
`auto_delete_in_days`	No
`sub_last_user_agent`	No
`lifetime_used_traffic`	No
`on_hold_expire_duration`	No
`data_limit_reset_strategy`	No		no_reset

Schema Changelog

Changes observed during successful MCP inspections.

Changed19 schema fields changedv0.2.4Oct 23, 2026

removedInput schema / $schema

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

removedInput schema / properties / onHoldExpireDuration / maximum
```
Removed value: -9007199254740991
```

removedOutput schema / $schema

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

changedOutput schema / 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 / 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 / data_limit / anyOf

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

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

changedOutput schema / 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 / inbounds / properties
```
Removed value: -{}
```
removedOutput schema / properties / lifetime_used_traffic / maximum
```
Removed value: -9007199254740991
```
removedOutput schema / properties / lifetime_used_traffic / minimum
```
Removed value: --9007199254740991
```

changedOutput schema / 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 / note / anyOf

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

changedOutput schema / 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 / proxies / additionalProperties / properties
```
Removed value: -{}
```
removedOutput schema / properties / proxies / properties
```
Removed value: -{}
```

changedOutput schema / properties / sub_last_user_agent / anyOf

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

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

Changed5 schema fields changedv0.2.3Sep 7, 2026

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

removedOutput schema / 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 / 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 / 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 / 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

A3.8/5.0

Behavior4/5

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

The description adds meaningful behavioral context beyond the annotations: on_hold means inactive until first connection, then the timer begins. This clarifies the state transition and timing, which is valuable even though annotations already indicate a non-read-only, non-destructive mutation. It does not cover idempotency or effects on an already-active user.

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?

The description is a single tightly written sentence that front-loads the core action and then explains the key behavior. Every clause earns its place with no repetition or filler.

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?

Given the presence of an output schema and annotations covering safety, the description supplies the critical domain-specific behavior of on_hold and the timer. The main gap is the lack of parameter guidance, particularly for the required username field, but overall the agent has enough to call it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The description does not mention either parameter. Schema coverage is 50%, with onHoldExpireDuration documented only in the schema, and username undocumented in both schema and description. The description fails to compensate for the uncovered required username parameter or add any parameter meaning beyond the structured fields.

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 states a specific verb and resource: setting a user's status to on_hold. It explains the unique on_hold state (inactive until first connection, then timer starts), which implicitly distinguishes it from activate/deactivate siblings, but does not explicitly name those alternatives.

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

Usage Guidelines4/5

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

It provides a clear usage scenario: provisioning an account ahead of time without starting its clock. It does not state when not to use the tool or explicitly compare it to alternatives like activate or deactivate, but the intended context is clear.

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

Deploy Server