Skip to main content
Glama

Update Role

update_role
Idempotent

Update an existing access role by its id (get the id from list_roles). Only the fields you pass are changed: name, description, privileges, isDefault. NOTE: privileges REPLACES the whole privilege list — read the current list from list_roles first and pass the full desired set, or privileges not included are revoked. isDefault=true makes this the role people get when added to a workspace without a role named (the previous default stops being default); an app always has exactly one default, so to move it pass isDefault=true on the new one rather than false on the old one. set_default_role does the same by role key. What a role can do is only the app's default setup until you have read it here. Control access with a flag rule on a privilege (preferred) or on the role key, never with a hard-coded role check in app code. A privilege rule matches the whole key: privileges contains "REPORTS_VIEW" does not match REPORTS_VIEW_ALL. Before writing app code that consumes this, call get_integration_guide with topic=team and the framework the app uses.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesRole id from list_roles (this tool addresses roles by id).
appNoId of the Bridge app to act on for this call (see list_apps). Omit to use the current app.
nameNoNew display name.
isDefaultNotrue makes this the default role for people added without a role named.
privilegesNoFull replacement privilege list (omitted privileges are revoked).
descriptionNoNew description.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.7/5.0
Behavior5/5

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

Goes well beyond the annotations: it discloses that privileges is a full replacement (omitted privileges are revoked), that isDefault=true demotes the previous default and that only one default can exist (so move it by setting the new one true, not the old one false), and that a privilege rule matches the whole key (REPORTS_VIEW does not match REPORTS_VIEW_ALL). These are exactly the side effects an agent needs and are not derivable from readOnly/idempotent hints alone.

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?

Front-loaded with purpose and the key replacement warning, but it runs long and the closing guidance about flag rules versus hard-coded role checks and calling get_integration_guide is about app design rather than selecting or invoking this tool. That material, while useful, does not strictly earn its place in a tool description and bloats an otherwise dense block.

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?

With 6 parameters (1 required), full schema coverage, and no output schema needed, the description supplies everything an agent needs: id source, partial-update behavior, the destructive replacement caveat, and the default-role semantics. Nothing required to call it correctly is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the description adds real meaning the schema lacks: 'Only the fields you pass are changed' (partial-update semantics) and the isDefault migration behavior (set true on the new role rather than false on the old). The privileges replacement rule reinforces the schema text rather than merely repeating it.

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?

States a specific verb+resource ('Update an existing access role by its id') and immediately distinguishes itself from create_role/get_role/delete_role by naming the source of the id (list_roles). An agent can identify the operation without opening the schema.

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

Usage Guidelines5/5

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

Explicit routing: get the id from list_roles, read the current privilege list before replacing it, and 'set_default_role does the same by role key' as an alternative for the default-role case. It even points to get_integration_guide before writing consuming code, so when-to-use and alternatives are fully covered.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.