Skip to main content
Glama

Invite User

create_invite_request
Destructive

Invite a new user by email to access the authenticated customer account with a chosen set of panel roles. Confirming the invitation SENDS AN EMAIL to the invitee. Invite lifecycle: this tool creates a pending invitation and emails the invitee -> the invitation is listed in list_invite_requests (and can be revoked with cancel_invite_request) while unanswered -> once the invitee accepts, their access appears in list_user_accesses with the granted roles. Valid role names: Billing, Commercial, Compliance, Porting, SuperAdmin, Technical (SuperAdmin grants full access including user management). Returns the created invitation (id, email, name, roles, status, created_at).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesInvitee's full name, shown in the invitation and the user list.
emailYesEmail address the invitation is sent to — the invitee will sign in with it.
rolesYesPanel roles to grant when the invitee accepts, by role name. Valid names: Billing, Commercial, Compliance, Porting, SuperAdmin, Technical. At least one is required.
confirmation_tokenNoLeave empty on the first call — the tool returns a confirmation_token + preview and sends nothing. Re-call with that confirmation_token to create the invitation and send the email. If the confirming call's response is lost, it is safe to retry with the SAME confirmation_token — a repeat returns the original result and never emails twice.

Schema Changelog

Changes observed during successful MCP inspections.

No schema history has been recorded yet.

TDQS

A4.4/5.0
Behavior5/5

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

Beyond the annotations, the description discloses that confirming SENDS AN EMAIL, explains the two-step confirmation_token flow (first call returns a preview and sends nothing), and states that retrying the confirming call with the same token never emails twice. These are exactly the side-effect and retry semantics an agent needs and are not derivable from the annotations alone.

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?

The description is front-loaded with purpose, then the email side effect, then lifecycle, then return shape — a logical order. It is somewhat dense with the lifecycle chain, but every sentence carries information an agent needs, so only minor trimming is possible.

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 no output schema, the description compensates by naming the returned fields (id, email, name, roles, status, created_at), and it covers the destructive/email side effect and the token flow. Nothing required to invoke it correctly is missing.

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 schema already documents email, name, roles, and confirmation_token. The description largely restates what the schema provides (role names, confirmation flow), adding no syntax or format detail beyond it; baseline 3 applies.

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 states a specific verb and resource ('Invite a new user by email to access the authenticated customer account with a chosen set of panel roles') and immediately disambiguates from siblings by naming list_invite_requests and cancel_invite_request. An agent can distinguish it from every other create_* tool 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 Guidelines4/5

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

It lays out the full invite lifecycle and explicitly routes the agent to list_invite_requests for pending invites and cancel_invite_request for revocation, so the surrounding context is clear. It stops short of stating a hard when-not-to-use condition, but there is no competing invitation-creation tool to exclude.

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