MCP ServerTool Reference
List Users
List Users MCP tool.
List Users
List users with get_user fields. Deleted (archived) users are excluded unless status is "deleted". role_id is from list_roles; search matches first name, last name or email.
Contract
| Field | Value |
|---|---|
| Tool name | list_users |
| Domain | users |
| Required scopes | people:read |
| Title | List users |
| Read only hint | true |
| Destructive hint | false |
| Idempotent hint | false |
| Open world hint | false |
| Bulk limit | none |
| Timeout | 10000ms |
| Kill switch key | users.list |
| REST sibling | GET /api/public/v1/users |
Input Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100
},
"cursor": {
"type": "string",
"pattern": "^mcp_[a-z0-9]+$"
},
"role_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"status": {
"type": "string",
"enum": [
"active",
"pending",
"invited",
"inactive",
"suspended",
"deleted"
]
},
"created_after": {
"type": "string",
"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))$"
},
"created_before": {
"type": "string",
"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))$"
},
"search": {
"type": "string",
"minLength": 1
},
"sort_by": {
"type": "string",
"enum": [
"created_at",
"email",
"first_name",
"last_name"
]
},
"sort_order": {
"type": "string",
"enum": [
"asc",
"desc"
]
}
},
"additionalProperties": false
}Output Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"content": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "text"
},
"text": {
"type": "string"
}
},
"required": [
"type",
"text"
],
"additionalProperties": false
}
}
},
"required": [
"content"
],
"additionalProperties": false
}