Skip to main content
Glama

add_role

Add a new role to a channel and return its bearer token once. Allows a coding-agent session to read messages and consent to protected pin updates.

Instructions

ADMIN ONLY (HTTP transport): add a new role to an existing channel and return its bearer token (shown exactly once). The channel must have room (<= 12 roles) and the role must be new. Existing roles, tokens and message history are untouched; the new role can read the whole channel and, like every member, its consent becomes required for future protected-pin updates. Role is a lowercase slug.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
roleYes
channelYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.6/5.0
Behavior5/5

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

With no annotations, the description carries the full burden and does so: the token is shown exactly once, existing roles/tokens/message history are untouched, the new role can read the whole channel, and its consent becomes required for future protected-pin updates. These are non-obvious, irreversible, and permission-relevant traits that no structured field conveys.

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?

Front-loaded with the ADMIN ONLY gate, then constraints, side effects, and the slug format. Dense and largely waste-free, though the trailing 'Role is a lowercase slug' sentence reads as an afterthought appended to a long paragraph.

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?

An output schema exists, so return-value structure need not be described, but the description still supplies the critical irreversibility note (token shown once) plus auth level, capacity limit, and side effects. Nothing an agent needs to call this 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 description coverage is 0%, so the description must compensate. It does for `role` (lowercase slug, must be new) but only implicitly for `channel` (an existing channel). Adds meaningful value over the bare schema, with one parameter left lightly specified.

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 and resource ('add a new role to an existing channel') plus the return artifact (bearer token). It is immediately distinguishable from siblings such as list_roles and rotate_token without opening any schema.

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?

Explicitly gates usage: ADMIN ONLY, HTTP transport, channel must have room (<= 12 roles), and the role must be new. It does not, however, route the agent to an alternative when a precondition fails (e.g. rotate_token for an existing role), so it stops short of full when-not guidance.

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