Skip to main content
Glama
SmartBear

SmartBear MCP server

Official
by SmartBear

Contract Testing: Admin List Roles

contract-testing_admin_list_roles
Read-onlyIdempotent

List all roles in a SmartBear contract-testing workspace. Specify page number and page size to paginate through results.

Instructions

List all roles defined in the workspace (admin).

Toolset: Admin

Parameters:

  • pageNumber (number): Page number (default: 1)

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

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageSizeNoResults per page
pageNumberNoPage number
Install Server

TDQS

A3.7/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is well established. The description adds workspace scoping and pagination defaults, which is useful, but it does not disclose return format, ordering, or admin permission requirements beyond what annotations imply.

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?

The description is short and front-loaded with the main purpose, and the parameter list is compact. However, 'Toolset: Admin' and the repeated parameter list duplicate the title and schema, so not every line provides unique value.

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 read-only, paginated list operation with rich annotations and full schema coverage, the description supplies enough information to invoke the tool correctly. There is no output schema, so the return structure is unstated, but the tool's simple nature makes this a minor gap.

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 both parameters. The description repeats the two parameters with their defaults, adding no extra semantic meaning such as maximum page size, filtering, or ordering behavior.

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 states an explicit verb ('List'), a concrete resource ('all roles defined in the workspace'), and clarifies it is an admin operation. This clearly distinguishes it from role-specific siblings like admin_get_role or admin_create_role.

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 gives clear context for the main use case but never mentions alternatives or when not to use it. It does not route the agent to admin_get_role for single-role lookup or admin_create_role for creation, so selection must be inferred from the tool name and sibling list.

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

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