Skip to main content
Glama
Sign In
SmartBear MCP server

SmartBear MCP server

Official
by SmartBear
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

Contract Testing: Admin List Users

contract-testing_admin_list_users
Read-onlyIdempotent

Lists workspace users for administrators, with filters for active status, name or 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 (default: 1)

  • size (number): Results per page (default: 5)

Input Schema

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

Output Schema

NameRequiredDescriptionDefault
pageNo
usersNo
_linksNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.43.0
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "$defs": {
+    "EmbeddedLink": {
+      "additionalProperties": {},
+      "properties": {
+        "href": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        },
+        "templated": {
+          "type": "boolean"
+        },
+        "title": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "Page": {
+      "additionalProperties": {},
+      "properties": {
+        "number": {
+          "type": "number"
+        },
+        "size": {
+          "type": "number"
+        },
+        "totalElements": {
+          "type": "number"
+        },
+        "totalPages": {
+          "type": "number"
+        }
+      },
+      "type": "object"
+    },
+    "Permission": {
+      "additionalProperties": {},
+      "properties": {
+        "description": {
+          "type": "string"
+        },
+        "group": {
+          "type": "string"
+        },
+        "label": {
+          "type": "string"
+        },
+        "scope": {
+          "type": "string"
+        },
+        "uuid": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "User": {
+      "additionalProperties": {},
+      "properties": {
+        "_embedded": {
+          "additionalProperties": {},
+          "properties": {
+            "roles": {
+              "items": {
+                "$ref": "#/$defs/UserRole"
+              },
+              "type": "array"
+            },
+            "teams": {
+              "items": {
+                "$ref": "#/$defs/UserTeam"
+              },
+              "type": "array"
+            }
+          },
+          "type": "object"
+        },
+        "_links": {
+          "additionalProperties": {},
+          "properties": {
+            "pf:tokens": {
+              "$ref": "#/$defs/EmbeddedLink"
+            },
+            "self": {
+              "$ref": "#/$defs/EmbeddedLink"
+            }
+          },
+          "type": "object"
+        },
+        "active": {
+          "type": "boolean"
+        },
+        "authenticationSource": {
+          "type": "string"
+        },
+        "createdAt": {
+          "type": "string"
+        },
+        "email": {
+          "type": "string"
+        },
+        "externalId": {
+          "type": "string"
+        },
+        "externalIdpId": {
+          "type": "string"
+        },
+        "externalIdpUsername": {
+          "type": "string"
+        },
+        "firstName": {
+          "type": "string"
+        },
+        "identityProviderId": {
+          "type": "string"
+        },
+        "lastLogin": {
+          "type": "string"
+        },
+        "lastName": {
+          "type": "string"
+        },
+        "lastTimeTokenAccessed": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        },
+        "seatType": {
+          "type": "string"
+        },
+        "type": {
+          "anyOf": [
+            {
+              "const": 0,
+              "type": "number"
+            },
+            {
+              "const": 1,
+              "type": "number"
+            }
+          ]
+        },
+        "typeDescription": {
+          "type": "string"
+        },
+        "updatedAt": {
+          "type": "string"
+        },
+        "uuid": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "UserRole": {
+      "additionalProperties": {},
+      "properties": {
+        "_links": {
+          "additionalProperties": {},
+          "properties": {
+            "self": {
+              "$ref": "#/$defs/EmbeddedLink"
+            }
+          },
+          "type": "object"
+        },
+        "name": {
+          "type": "string"
+        },
+        "permissions": {
+          "items": {
+            "$ref": "#/$defs/Permission"
+          },
+          "type": "array"
+        },
+        "uuid": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "UserTeam": {
+      "additionalProperties": {},
+      "properties": {
+        "_links": {
+          "additionalProperties": {},
+          "properties": {
+            "pf:integrations": {
+              "$ref": "#/$defs/EmbeddedLink"
+            },
+            "pf:membership": {
+              "$ref": "#/$defs/EmbeddedLink"
+            },
+            "self": {
+              "$ref": "#/$defs/EmbeddedLink"
+            }
+          },
+          "type": "object"
+        },
+        "name": {
+          "type": "string"
+        },
+        "uuid": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    }
+  },
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "additionalProperties": {},
+  "properties": {
+    "_links": {
+      "additionalProperties": {},
+      "properties": {
+        "next": {
+          "$ref": "#/$defs/EmbeddedLink"
+        },
+        "previous": {
+          "$ref": "#/$defs/EmbeddedLink"
+        },
+        "self": {
+          "$ref": "#/$defs/EmbeddedLink"
+        }
+      },
+      "type": "object"
+    },
+    "page": {
+      "$ref": "#/$defs/Page"
+    },
+    "users": {
+      "items": {
+        "$ref": "#/$defs/User"
+      },
+      "type": "array"
+    }
+  },
+  "type": "object"
+}
  2. Addedv0.40.0
  3. Removedv0.34.0
  4. First observedv0.27.1

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and a closed world, so the safety profile is carried structurally; the description adds only the admin-toolset framing. It does not mention that results are paginated with a small default page size of 5, meaning a caller may easily see a truncated list and mistake it for the full set — the most important behavioral caveat here.

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

Conciseness3/5

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

The lead sentence is front-loaded and short, but the subsequent toolset and parameter bullets duplicate structured data the agent already receives. The parameter enumeration is filler rather than value, which dilutes an otherwise efficient definition.

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 simple, fully-specified read tool with complete schema coverage, rich annotations and an output schema covering return values, the definition is close to sufficient to call correctly. The remaining gap is behavioral rather than structural — no note on result-set scope or how paging interacts with "all 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 every parameter is already documented, and the description's parameter block simply repeats those descriptions verbatim (plus the already-present defaults). It adds no syntax, interaction, or edge-case meaning beyond what the schema provides, so baseline 3 applies.

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?

States a specific verb and resource ("List all users in the workspace") and the admin qualifier signals the elevated scope, which reasonably separates it from service-account or team-scoped listing siblings. It stops short of naming a specific alternative such as contract-testing_admin_list_team_users, so the differentiation is inferred rather than explicit.

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

Usage Guidelines2/5

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

There is no when-to-use guidance: nothing says when to prefer this over admin_get_user, admin_list_team_users, or admin_get_system_account_tokens, nor are privilege prerequisites described beyond the bare "(admin)" tag. The reader must infer usage purely from the tool name.

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