Skip to main content
Glama

wp_list_users

List WordPress users with filtering by role or search to view roles, registration dates, and activity status.

Instructions

Lists users from a WordPress site with comprehensive filtering and detailed user information including roles, registration dates, and activity status.

Usage Examples: • List all users: wp_list_users • Search users: wp_list_users --search="john" • Filter by role: wp_list_users --roles=["editor","author"] • Find admins: wp_list_users --roles=["administrator"] • Combined search: wp_list_users --search="smith" --roles=["subscriber"]

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
siteNoThe ID of the WordPress site to target (from mcp-wordpress.config.json). Required if multiple sites are configured.
rolesNoLimit results to users with specific roles.
searchNoLimit results to those matching a search term.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.9.2

TDQS

A3.7/5.0
Behavior2/5

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

With no annotations provided, the description carries full burden but only states it 'lists users with comprehensive filtering and detailed information.' It doesn't disclose behavioral traits like whether this is a read-only operation (implied but not stated), pagination behavior, rate limits, authentication requirements, or what happens with large result sets. For a list tool with no annotations, this is insufficient.

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?

The description is appropriately sized and front-loaded: the first sentence clearly states the purpose, followed by well-organized usage examples that demonstrate practical applications. Every sentence earns its place by illustrating different parameter combinations.

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

Completeness3/5

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

Given 3 parameters with 100% schema coverage but no annotations and no output schema, the description is adequate for basic usage but incomplete. It doesn't address what the return format looks like (list structure, fields included), pagination, error conditions, or performance considerations for a list operation that could return many users.

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 the schema already fully documents all 3 parameters. The description adds minimal value beyond what's in the schema - it mentions filtering capabilities generally and provides usage examples that illustrate parameter combinations, but doesn't add semantic meaning beyond the schema's parameter descriptions.

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?

The description clearly states the tool's purpose with specific verb ('Lists') and resource ('users from a WordPress site'), plus it distinguishes from siblings by specifying 'comprehensive filtering and detailed user information' which differentiates it from wp_get_user (singular) and wp_search_site (broader search).

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?

The description provides clear context through usage examples showing when to use the tool (searching, filtering by role, combined queries), but doesn't explicitly state when NOT to use it or mention alternatives like wp_search_site for broader searches or wp_get_user for single user retrieval.

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