Skip to main content
Glama
SmartBear

SmartBear MCP server

Official
by SmartBear

Contract Testing: Admin List Users

contract-testing_admin_list_users
Read-onlyIdempotent

List all users in the workspace with optional filters for active status, name/email, user type, and pagination.

Instructions

List all users in the workspace (admin).

Toolset: Admin

Parameters:

  • active (boolean): Filter by active/inactive status

  • q (string): Filter by name or email

  • userType (number): 0 = regular users, 1 = system accounts

  • page (number): Page number

  • size (number): Results per page

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
qNoFilter by name or email
pageNoPage number
sizeNoResults per page
activeNoFilter by active/inactive status
userTypeNo0 = regular users, 1 = system accounts
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, idempotentHint=true. The description adds that it lists all users (admin), which aligns with annotations. It does not add significant behavioral details beyond what annotations provide, but is not contradictory.

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 very concise: one line for purpose followed by a bulleted list of parameters. No extraneous information, and the most important part (purpose) is front-loaded.

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?

The description covers the basic operation and parameter list, but lacks details on pagination behavior, default sorting, response format (no output schema), and prerequisites for admin access. It is minimally sufficient but could be more complete.

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 baseline is 3. The description repeats the parameter names and brief descriptions from the schema without adding new meaning, usage guidance, or examples. It offers no extra value beyond the schema.

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 it lists all users in the workspace, with an admin scope. The verb 'list' and resource 'users' are specific, and the title 'Admin List Users' distinguishes it from siblings like admin_get_user (single) and admin_create_user.

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 description indicates it is an admin tool but does not explicitly specify when to use it vs alternatives like admin_get_user or other list tools. Usage context is implied by the name and parameter listing, but no direct comparison or exclusion is provided.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/SmartBear/smartbear-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server