Skip to main content
Glama
Sign In
SmartBear MCP server

SmartBear MCP server

Official
by SmartBear
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

Contract Testing: Admin Get Role

contract-testing_admin_get_role
Read-onlyIdempotent

Retrieves detailed information for a specific role using its UUID, helping administrators inspect role definitions and permissions in SmartBear contract testing.

Instructions

Retrieve details for a specific role by UUID (admin).

Toolset: Admin

Parameters:

  • roleId (string) required: UUID of the role

Input Schema

NameRequiredDescriptionDefault
roleIdYesUUID of the role

Output Schema

NameRequiredDescriptionDefault
nameNo
uuidNo
_linksNo
createdNo
_actionsNo
createdAtNo
updatedAtNo
descriptionNo
permissionsNo
systemDefinedNo

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"
+    }
+  },
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "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"
+}
  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, destructiveHint=false, and openWorldHint=false, so the safety profile needs no restating. The description adds only the admin toolset label and a restatement of the parameter, with no information on permissions required, error behavior for unknown UUIDs, or scope of the returned role object.

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 opening sentence is front-loaded and unambiguous, and the toolset label is a cheap orienting cue. The Parameters block is pure duplication of the schema and is the one section that does not earn its place.

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?

This is a single-required-parameter read-only lookup with an output schema, so return values need no explanation and the annotations carry the safety profile. Nothing an agent needs in order to call it correctly is missing from the definition.

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% and the single parameter roleId is already documented as "UUID of the role" in the schema. The description's Parameters block duplicates that verbatim, adding no new format hints (e.g. where to find the UUID, whether it is the role's id or name field).

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?

The description states a specific verb and resource ("Retrieve details for a specific role by UUID") and marks it as admin scope, which distinguishes it from the many non-admin contract-testing tools in the sibling list. It does not explicitly name contract-testing_admin_list_roles as the counterpart, but "by UUID" implicitly separates single-role lookup from listing.

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?

Usage is only implied: the phrase "by UUID" signals that a role UUID must already be known, hinting that a listing call comes first. There is no explicit when-to-use, when-not, or named alternative (e.g. contract-testing_admin_list_roles), so an agent must infer the routing.

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