Skip to main content
Glama

update_role

Update a role's name and/or scope_expressions. Omitted fields are left unchanged (not cleared). Requires an admin owner_key.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesThe role's id.
nameNoNew name, or omit to leave unchanged.
owner_keyNoOwner key. Must belong to an admin member. Optional. If omitted, defaults to the owner_key resolved from the connection's `Authorization: Bearer <owner_key>` header.
scope_expressionsNoNew scope_expressions, or omit to leave unchanged.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

With no annotations provided, the description carries the full burden and does a solid job: it states the mutation intent, the partial-update semantics ('Omitted fields are left unchanged (not cleared)'), and the authorization requirement. It leaves some behavior unspecified, such as what explicit null values do versus omitted fields and what the response contains, but the disclosed traits are the most important ones.

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?

Two concise sentences, with the action and target front-loaded and the key partial-update and auth caveats right after. No filler, no repetition of schema content.

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?

For a simple 4-parameter update tool with full schema coverage, the description covers the core information an agent needs: what to update, partial-update behavior, and the required credential context. It does not mention response format or error cases, but it is otherwise complete enough to invoke the tool correctly.

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 baseline is 3. The description adds the 'not cleared' nuance, but it does not clarify the meaning of explicit nulls, which are allowed in the schema for name and scope_expressions, or otherwise expand on the parameter-level details already present.

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 uses a specific verb ('Update') and identifies the exact resource (a role) along with the mutable fields ('name and/or scope_expressions'). It clearly distinguishes this tool from create_role, delete_role, and other role-related siblings based on action alone.

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?

The description provides clear context: use this when updating an existing role's name or scope expressions, and it notes the admin owner_key requirement. It does not explicitly contrast against alternatives like create_role or delete_role, but no exclusion guidance is needed for obvious sibling differentiation.

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.

Resources