Skip to main content
Glama

List users

wp_list_users
Read-onlyIdempotent

List the user accounts of this site, one page at a time, optionally filtered by role or a search term. Returns users (id, login, email, name = display name, roles) and total, the number of matches across all pages. Needs list_users. One account with first and last name and registration date: wp_get_user; profile fields: wp_get_user_meta. Forwarded by AlphaBridge Connect to the one site this connection reaches.

Input Schema

NameRequiredDescriptionDefault
pageNoPage number, starting at 1. Default 1.
roleNoOnly users with this role slug, e.g. administrator, editor, author, contributor, subscriber or a role a plugin added. Omitted: every role.
searchNoWordPress picks the fields by the term: with "@" the email, starting with http:// or https:// the URL (on a large multisite network the general fields instead), a number the login (or the exact id), otherwise login, email, URL, nicename and display name; matched anywhere in the field. Omitted: no filter.
per_pageNoUsers per page, 1 to 100 (values outside are clamped). Default 20.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changed
    • addedInput schema / properties / page / description
      Added value: +"Page number, starting at 1. Default 1."
    • addedInput schema / properties / per_page / description
      Added value: +"Users per page, 1 to 100 (values outside are clamped). Default 20."
    • addedInput schema / properties / role / description
      Added value: +"Only users with this role slug, e.g. administrator, editor, author, contributor, subscriber or a role a plugin added. Omitted: every role."
    • addedInput schema / properties / search / description
      Added value: +"WordPress picks the fields by the term: with \"@\" the email, starting with http:// or https:// the URL (on a large multisite network the general fields instead), a number the login (or the exact id), otherwise login, email, URL, nicename and display name; matched anywhere in the field. Omitted: no filter."
  2. First observed

TDQS

A4.4/5.0
Behavior5/5

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

Annotations already declare readOnly/idempotent/non-destructive, and the description adds what they cannot: the required capability ('Needs list_users'), that results are paged, the exact field set returned (id, login, email, name, roles), and that 'total' counts matches across all pages. The AlphaBridge forwarding note also clarifies the single-site scope, consistent with openWorldHint=false.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loads purpose and pagination, then alternatives, then return shape. Dense but almost every clause carries information; the compression in the alt-sibling sentence ('One account with first and last name and registration date: wp_get_user') is terse but readable.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the description's return-field summary and the cross-page 'total' semantics are exactly what the agent needs. Pagination, capability requirement, filtering options and the single-site forwarding scope are all covered.

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 100% and the schema already documents page, role, search matching rules and per_page clamping in detail. The description only restates that filtering by role or search term is possible, adding nothing beyond the schema, so the baseline 3 applies.

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?

Opens with a specific verb and resource ('List the user accounts of this site') plus the exact scope: paginated, optionally filtered by role or search term. It is clearly distinguishable from wp_get_user and wp_get_user_meta, which are named as different operations.

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?

Explicitly routes the agent: 'One account with first and last name and registration date: wp_get_user; profile fields: wp_get_user_meta.' That is clear alternative-routing. It does not name an exclusions case (e.g. when not to page through the list), so it stops short of a full when/when-not statement.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources