Skip to main content
Glama

Update a specific role

action1_update_role
Destructive

Update an existing role by ID, including its name, description, and scoped permissions. Preview changes with dry_run or confirm execution to modify role settings.

Instructions

Update a specific role. Updates a role specified by its ID. Perm: manage_roles.

Input Schema

NameRequiredDescriptionDefault
bodyYesRequest body
confirmNoRequired to execute. Exact string "YES".
dry_runNoDefault true (preview). Set false to execute.
role_idYesProvide a specific role ID.

Output Schema

NameRequiredDescriptionDefault
idNo
nameNo
selfNo
toolNo
typeNo
usersNo
dry_runNo
would_sendNo
descriptionNo
scoped_permissionsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed15 schema fields changedv0.6.0
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • changedInput schema / properties / body / description
      Previous value: -"Request body (schema: object)"New value: +"Request body"
    • addedInput schema / properties / body / properties
      Added value: +{
      +  "description": {
      +    "description": "The role description.",
      +    "type": "string"
      +  },
      +  "name": {
      +    "description": "The role name.",
      +    "type": "string"
      +  },
      +  "scoped_permissions": {
      +    "items": {
      +      "additionalProperties": {},
      +      "properties": {
      +        "exclude_scope": {
      +          "items": {
      +            "additionalProperties": {},
      +            "propertyNames": {
      +              "type": "string"
      +            },
      +            "type": "object"
      +          },
      +          "type": "array"
      +        },
      +        "include_scope": {
      +          "items": {
      +            "additionalProperties": {},
      +            "propertyNames": {
      +              "type": "string"
      +            },
      +            "type": "object"
      +          },
      +          "type": "array"
      +        },
      +        "permission": {
      +          "description": "The permission ID. List of available permissions can be found by calling /API/permissions.",
      +          "type": "string"
      +        },
      +        "restrictions": {
      +          "additionalProperties": {},
      +          "description": "Optional restrictions for `include_scope` only (not for `exclude_scope`).",
      +          "propertyNames": {
      +            "type": "string"
      +          },
      +          "type": "object"
      +        }
      +      },
      +      "required": [
      +        "permission",
      +        "include_scope",
      +        "exclude_scope"
      +      ],
      +      "type": "object"
      +    },
      +    "type": "array"
      +  }
      +}
    • changedOutput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • changedOutput schema / additionalProperties
      Previous value: -trueNew value: +{}
    • addedOutput schema / properties / description
      Added value: +{}
    • addedOutput schema / properties / dry_run
      Added value: +{}
    • addedOutput schema / properties / id
      Added value: +{}
    • addedOutput schema / properties / name
      Added value: +{}
    • addedOutput schema / properties / scoped_permissions
      Added value: +{}
    • addedOutput schema / properties / self
      Added value: +{}
    • addedOutput schema / properties / tool
      Added value: +{}
    • addedOutput schema / properties / type
      Added value: +{}
    • addedOutput schema / properties / users
      Added value: +{}
    • addedOutput schema / properties / would_send
      Added value: +{}
  2. First observedv0.5.0

TDQS

A4.2/5.0
Behavior4/5

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

While annotations handle the destructive and non-read-only nature, the description adds critical operational context: the need for a specific role ID and the exact permission requirement. This helps the agent understand the necessary pre-conditions for execution.

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

Conciseness5/5

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

The description is extremely concise, using two short sentences to convey the core function and the authorization context without any filler.

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?

Despite the complexity of the input body and the existence of `dry_run` and `confirm` parameters, the description is minimally complete. It provides the necessary context (ID requirement and permission scope) that an agent needs to decide if this tool is the correct fit.

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?

The schema coverage is 100%, meaning the input schema is already highly detailed. The description doesn't add technical meaning beyond confirming the primary ID parameter and the content updates, thus meeting the baseline score for perfect schema coverage.

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 clearly states the action ('Update'), the resource ('a specific role'), and uses the explicit context of being specified by its ID. Given the large list of siblings, this phrasing easily distinguishes it from create, list, or delete actions.

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

Usage Guidelines4/5

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

It clearly indicates the target is a role specified by ID, inherently differentiating it from global operations. The inclusion of the required permission ('Perm: manage_roles') acts as a strong guide for usage context and authorization.

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