Skip to main content
Glama

mcp_list_users

List WordPress users with role and search filters, returning IDs, usernames, emails, roles, and registration dates with pagination for browsing site accounts.

Instructions

List WordPress users (id, username, email, display_name, first_name, last_name, roles, registered) with role/search filters. Returns { users, total, page }.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "site": "<site>"
    },
    "name": "mcp_list_users"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageNoPage number (default 1)
roleNoFilter by role slug (administrator, editor, author, contributor, subscriber, or a custom role)
siteYesSite id (see list_sites)
orderNoSort direction (default DESC)
searchNoSearch login, email, URL, nicename or display name (wildcard on both sides)
orderbyNoOrder by field (default registered)
per_pageNoUsers per page (default 20)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed15 schema fields changedv3.14.0
    • removedInput schema / properties / order / default
      Removed value: -"DESC"
    • changedInput schema / properties / order / description
      Previous value: -"Sort direction"New value: +"Sort direction (default DESC)"
    • removedInput schema / properties / orderby / default
      Removed value: -"registered"
    • changedInput schema / properties / orderby / description
      Previous value: -"Order by field"New value: +"Order by field (default registered)"
    • addedInput schema / properties / orderby / enum
      Added value: +[
      +  "registered",
      +  "login",
      +  "nicename",
      +  "email",
      +  "url",
      +  "display_name",
      +  "name",
      +  "post_count",
      +  "id"
      +]
    • removedInput schema / properties / page / default
      Removed value: -1
    • changedInput schema / properties / page / description
      Previous value: -"Page number"New value: +"Page number (default 1)"
    • addedInput schema / properties / page / minimum
      Added value: +1
    • changedInput schema / properties / page / type
      Previous value: -"number"New value: +"integer"
    • removedInput schema / properties / per_page / default
      Removed value: -20
    • changedInput schema / properties / per_page / description
      Previous value: -"Users per page"New value: +"Users per page (default 20)"
    • addedInput schema / properties / per_page / minimum
      Added value: +1
    • changedInput schema / properties / per_page / type
      Previous value: -"number"New value: +"integer"
    • changedInput schema / properties / role / description
      Previous value: -"Filter by role (administrator, editor, etc.)"New value: +"Filter by role slug (administrator, editor, author, contributor, subscriber, or a custom role)"
    • changedInput schema / properties / search / description
      Previous value: -"Search by name or email"New value: +"Search login, email, URL, nicename or display name (wildcard on both sides)"
  2. Changed2 schema fields changedv3.4.0
    • addedInput schema / properties / site
      Added value: +{
      +  "description": "Site id (see list_sites)",
      +  "type": "string"
      +}
    • addedInput schema / required
      Added value: +[
      +  "site"
      +]
  3. First observedv2.0.0

TDQS

A3.6/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the full burden. It partially discharges that by disclosing the return shape ({ users, total, page }), which tells the agent pagination exists, but it says nothing about permissions required, default page size, or whether the site must be accessible.

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?

Two compact sentences: the field list and filter mention come first, followed by the return shape. No filler, no repetition of the tool name as a standalone sentence.

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?

For a read-only paginated list tool with full schema coverage, the description covers resource, filters, and return envelope adequately. The main gap is the absence of routing guidance relative to the near-identical sibling wp_list_users and any note about the required 'site' parameter.

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 description coverage is 100%, so all seven parameters (page, role, site, order, search, orderby, per_page) are already documented in the schema. The description only echoes the role/search filters, adding no syntax or behavioral detail beyond that baseline.

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 ('List WordPress users') and enumerates the returned fields, so the agent knows exactly what it gets back. It does not distinguish itself from the sibling wp_list_users, which is the one thing an agent choosing between the two would need.

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

Usage Guidelines3/5

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

The phrase 'with role/search filters' implies the situations where this tool is useful, but there is no explicit when-to-use or when-not-to-use guidance, no mention of the sibling wp_list_users, and no note that 'site' is required.

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

Deploy Server

Other Tools