Skip to main content
Glama

List users

list_users
Read-only

List WordPress users with search, role filtering, sorting, and pagination. Use filters to find specific users, with roles and emails visible to administrators only.

Instructions

List users with search, role filtering, ordering and pagination. Email addresses and roles are only returned when the authenticated user has list_users capability (Administrator); otherwise WordPress returns just the public author profile.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoWhich page of results to return.
orderNoSort direction.asc
rolesNoFilter by role slugs, e.g. ["editor", "author"]. Administrator only.
searchNoMatch against name, username, email and slug.
orderbyNoWhich field to sort by.name
site_idNoWhich configured WordPress site to act on. Optional — with a single site configured it is used automatically; with several, the default site is used unless you name one. Run list_sites for valid ids.
per_pageNoHow many results per page.
has_published_postsNoOnly users who have published content.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv2.0.0
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • removedInput schema / additionalProperties
      Removed value: -false
    • addedInput schema / properties / page / maximum
      Added value: +9007199254740991
  2. First observedv1.0.0

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the description is not required to restate those. It adds value by disclosing that email addresses and roles are conditionally returned based on the list_users capability, which affects the response content and security context. This is a meaningful behavioral trait beyond the annotations.

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 sentences with zero filler. The primary purpose and capabilities are front-loaded in the first sentence, and the second sentence adds a critical permission nuance. Efficient and appropriately structured.

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 an 8-parameter tool with no output schema, the description covers the main functional aspects and the permission-based response variation. It does not describe the return format or pagination specifics beyond what the schema provides, but given the schema's thorough documentation and the read-only nature, it is sufficiently complete for an agent to invoke correctly.

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%, so the baseline is 3. The description summarizes the key filtering and pagination features but does not add new meaning beyond the schema's parameter descriptions. It repeats the Administrator-only constraint for roles, which is already in the schema. No additional syntax, format, or edge-case details are provided.

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?

States a specific verb (List) and resource (users) with explicit capabilities (search, role filtering, ordering, pagination). Clearly distinguishes from the singular get_user sibling and other user-related tools by focusing on the collection behavior.

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?

Implies usage for listing multiple users with filters, but does not explicitly contrast with get_user for single-user retrieval or mention when not to use it. The permission note hints at administrator vs public access but does not provide alternative tool routing. No exclusions or when-not-to-use guidance beyond the implicit scope.

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