Admin List Users

Immutable Catalog Entry

This descriptor comes from the active versioned Portal catalog.

READwave.wave_admin_list_users

• Contract tier: agent_ready
• Risk: read
• Catalog version: 2026-07-12.1
• Descriptor hash: 160d93dab9f66d499f2ca42f05fd5d3a41f7f16835fcd68dd3c75796e8fb4b76

List Synapse users with pagination. Requires an admin identity from server env or a verified primary Wave admin account.

Request Body

{
  "jsonrpc": "2.0",
  "id": "wave-wave-admin-list-users-example",
  "method": "tools/call",
  "params": {
    "name": "wave.wave_admin_list_users",
    "arguments": {
      "from": 1,
      "limit": 1,
      "guests": false,
      "deactivated": false,
      "name": "name_example"
    }
  }
}

Arguments Schema

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "from",
    "limit",
    "guests",
    "deactivated"
  ],
  "properties": {
    "from": {
      "type": "integer",
      "default": 0,
      "maximum": 9007199254740991,
      "minimum": 0,
      "description": "Zero-based Synapse user pagination offset."
    },
    "name": {
      "type": "string",
      "description": "Optional case-insensitive user name filter."
    },
    "limit": {
      "type": "integer",
      "default": 50,
      "maximum": 9007199254740991,
      "description": "Maximum Synapse users to return in this page.",
      "exclusiveMinimum": 0
    },
    "guests": {
      "type": "boolean",
      "default": false,
      "description": "Include guest accounts when true."
    },
    "deactivated": {
      "type": "boolean",
      "default": false,
      "description": "Include deactivated accounts when true."
    }
  },
  "additionalProperties": false
}

Output Schema

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "ok",
    "data",
    "error",
    "meta"
  ],
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Whether the Wave MCP operation completed successfully."
    },
    "data": {
      "anyOf": [
        {},
        {
          "type": "null"
        }
      ],
      "description": "Tool-specific Wave, Matrix, Synapse, or local navigation result."
    },
    "meta": {
      "type": "object",
      "description": "Safe execution and actor metadata without credential values.",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {}
    },
    "error": {
      "anyOf": [
        {
          "type": "object",
          "required": [
            "code",
            "message"
          ],
          "properties": {
            "code": {
              "type": "string",
              "description": "Stable machine-readable error classification."
            },
            "details": {
              "description": "Optional safe error context without credentials or request bodies."
            },
            "message": {
              "type": "string",
              "description": "Safe actionable error message."
            }
          },
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ],
      "description": "Safe error details when ok is false."
    }
  },
  "additionalProperties": false
}

Code Examples

cURL

curl -X POST 'https://portal.madpanda3d.com/api/mcp' \
  -H 'Authorization: Bearer mad_live_***' \
  -H 'Content-Type: application/json' \
  -d '{
  "jsonrpc": "2.0",
  "id": "wave-wave-admin-list-users-example",
  "method": "tools/call",
  "params": {
    "name": "wave.wave_admin_list_users",
    "arguments": {
      "from": 1,
      "limit": 1,
      "guests": false,
      "deactivated": false,
      "name": "name_example"
    }
  }
}'

Node.js

const response = await fetch('https://portal.madpanda3d.com/api/mcp', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer mad_live_***',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "jsonrpc": "2.0",
  "id": "wave-wave-admin-list-users-example",
  "method": "tools/call",
  "params": {
    "name": "wave.wave_admin_list_users",
    "arguments": {
      "from": 1,
      "limit": 1,
      "guests": false,
      "deactivated": false,
      "name": "name_example"
    }
  }
}),
});
const data = await response.json();
console.log(data);

Python

import requests

url = 'https://portal.madpanda3d.com/api/mcp'
headers = {
    'Authorization': 'Bearer mad_live_***',
    'Content-Type': 'application/json',
}
payload = {
  "jsonrpc": "2.0",
  "id": "wave-wave-admin-list-users-example",
  "method": "tools/call",
  "params": {
    "name": "wave.wave_admin_list_users",
    "arguments": {
      "from": 1,
      "limit": 1,
      "guests": false,
      "deactivated": false,
      "name": "name_example"
    }
  }
}
response = requests.post(url, headers=headers, json=payload, timeout=60)
print(response.json())

Example Responses

200 Success

{
  "ok": true,
  "message": "Tool wave.wave_admin_list_users executed successfully.",
  "note": "Response shape varies by MCP tool. Inspect live responses for exact fields."
}

502 Upstream Error

{
  "ok": false,
  "classification": "upstream_http_error",
  "message": "Upstream MCP returned a non-success status."
}