Skip to main content
Glama
SmartBear MCP server

SmartBear MCP server

Official
by SmartBear

Contract Testing: Admin Update Role

contract-testing_admin_update_role
Idempotent

Update an existing role's name, description, and permissions by role UUID to keep admin access aligned with current responsibilities.

Instructions

Update an existing role's name and permissions (admin).

Toolset: Admin

Parameters:

  • roleId (string) required: UUID of the role to update

  • name (string) required: Name of the role

  • permissions (array) required: Permissions granted by this role

  • description (string): Description of the role

Input Schema

NameRequiredDescriptionDefault
nameYesName of the role
roleIdYesUUID of the role to update
descriptionNoDescription of the role
permissionsYesPermissions granted by this 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

B3.3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, idempotentHint=true, destructiveHint=false and openWorldHint=false, and the description ('Update') is consistent with them. It adds that this is an Admin-toolset mutation, but does not say whether all fields are replaced or only supplied ones are changed, nor what admin privileges are required — meaningful gaps for a mutation tool.

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 opening sentence is tight and front-loaded, but the appended toolset/parameters section duplicates the schema word-for-word and adds length without information. Roughly half the text does not earn its place.

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?

With annotations and an output schema both present, the description only needs to cover purpose and mutation semantics. It covers purpose but leaves the replace-vs-merge question and permission prerequisites unstated, which matters for a 3-required-parameter admin mutation.

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 four parameters are already documented in the schema. The description's parameter block restates those exact descriptions verbatim (e.g. 'UUID of the role to update', 'Permissions granted by this role') without adding format, constraint, or example detail, 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?

The description opens with a specific verb+resource: 'Update an existing role's name and permissions', which clearly separates it from siblings such as contract-testing_admin_create_role and contract-testing_admin_delete_role. It does not explicitly name those alternatives, but the scope of the operation is unambiguous.

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 'Toolset: Admin' line imply this is a privileged operation and give some context, but there is no explicit statement of when to use this versus create/delete role or set_user_roles. The agent must infer the usage context from the name and the admin tag.

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