Skip to main content
Glama
Sign In
SmartBear MCP server

SmartBear MCP server

Official
by SmartBear
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

Contract Testing: Admin List Roles

contract-testing_admin_list_roles
Read-onlyIdempotent

Lists all roles defined in the workspace for admin review, with pagination.

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

NameRequiredDescriptionDefault
pageSizeNoResults per page
pageNumberNoPage number

Output Schema

NameRequiredDescriptionDefault
_linksNo
_embeddedNo
paginationNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.43.0
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "$defs": {
+    "Action": {
+      "additionalProperties": {},
+      "properties": {
+        "href": {
+          "type": "string"
+        },
+        "method": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        },
+        "title": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "EmbeddedLink": {
+      "additionalProperties": {},
+      "properties": {
+        "href": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        },
+        "templated": {
+          "type": "boolean"
+        },
+        "title": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "Permission": {
+      "additionalProperties": {},
+      "properties": {
+        "description": {
+          "type": "string"
+        },
+        "group": {
+          "type": "string"
+        },
+        "label": {
+          "type": "string"
+        },
+        "scope": {
+          "type": "string"
+        },
+        "uuid": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "Role": {
+      "additionalProperties": {},
+      "properties": {
+        "_actions": {
+          "items": {
+            "$ref": "#/$defs/Action"
+          },
+          "type": "array"
+        },
+        "_links": {
+          "additionalProperties": {},
+          "properties": {
+            "self": {
+              "$ref": "#/$defs/EmbeddedLink"
+            }
+          },
+          "type": "object"
+        },
+        "created": {
+          "type": "string"
+        },
+        "createdAt": {
+          "type": "string"
+        },
+        "description": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string"
+        },
+        "permissions": {
+          "items": {
+            "$ref": "#/$defs/Permission"
+          },
+          "type": "array"
+        },
+        "systemDefined": {
+          "type": "boolean"
+        },
+        "updatedAt": {
+          "type": "string"
+        },
+        "uuid": {
+          "type": "string"
+        }
+      },
+      "type": "object"
+    }
+  },
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "additionalProperties": {},
+  "properties": {
+    "_embedded": {
+      "additionalProperties": {},
+      "properties": {
+        "roles": {
+          "items": {
+            "$ref": "#/$defs/Role"
+          },
+          "type": "array"
+        }
+      },
+      "type": "object"
+    },
+    "_links": {
+      "additionalProperties": {},
+      "properties": {
+        "pf:reset": {
+          "$ref": "#/$defs/EmbeddedLink"
+        },
+        "self": {
+          "$ref": "#/$defs/EmbeddedLink"
+        }
+      },
+      "type": "object"
+    },
+    "pagination": {
+      "additionalProperties": false,
+      "properties": {
+        "pageNumber": {
+          "type": "number"
+        },
+        "pageSize": {
+          "type": "number"
+        },
+        "totalItems": {
+          "type": "number"
+        },
+        "totalPages": {
+          "type": "number"
+        }
+      },
+      "required": [
+        "pageNumber",
+        "pageSize",
+        "totalItems",
+        "totalPages"
+      ],
+      "type": "object"
+    }
+  },
+  "type": "object"
+}
  2. Addedv0.40.0
  3. Removedv0.34.0
  4. First observedv0.27.1

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, non-destructive, and closed-world, so the safety profile is fully covered without the description. The description adds essentially nothing beyond that, not even ordering, pagination limits, or total-count behavior for a paginated list.

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?

One front-loaded sentence establishes the purpose, followed by toolset and parameter notes. The parameter block is redundant with the schema and could be dropped, but overall it is short and easy to scan.

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

Completeness5/5

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

For a simple read-only paginated list with an output schema, full annotation coverage, and zero required parameters, the description is sufficient to call the tool correctly. Nothing an agent needs is missing given the structured data carrying the rest.

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 both parameters (pageNumber, pageSize) are already documented with defaults in the schema. The description's parameter block merely restates them verbatim and adds no semantics such as maximum page size or 1-based indexing implications.

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 roles defined in the workspace', which is unambiguous about the operation. It does not explicitly distinguish itself from the close sibling contract-testing_admin_get_role (single role fetch) or contract-testing_admin_list_permissions, so that differentiator is left to inference.

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 '(admin)' marker and 'list all' wording imply this is an admin-scoped bulk retrieval versus a single-role lookup, but no explicit when-to-use or when-not-to-use guidance is given. No prerequisites, permission requirements, or alternative siblings are named.

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