Skip to main content
Glama

clerk.ban_users

Ban one or more Clerk users, preventing them from signing in.

Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account.

Returns the updated user summaries and total count.

Cost = 8 tokens.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
user_idsYesList of one or more Clerk user ids (user_...) to ban.
clerk_instance_idNoClerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
usersNoUpdated user summaries for all banned users.
total_countNoNumber of users that were banned.

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. Added

TDQS

A4.2/5.0
Behavior4/5

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

With no annotations, the description carries the full burden. It discloses the effect (prevents sign-in), the return format (updated summaries and total count), a prerequisite (get_connected_accounts), and cost. It does not mention reversibility or auth requirements, but these are not critical for basic use.

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 four short, information-dense sentences covering the action, prerequisite, return value, and cost. Every sentence earns its place with no unnecessary 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?

Given an output schema exists and parameters are fully described, the description covers the essential behavioral aspects: effect, return, prerequisite, and cost. It could optionally mention that unban_users reverses the action, but it is complete enough for selecting and invoking 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 coverage is 100%, and the description largely mirrors the schema's own parameter descriptions (e.g., clerk_instance_id). It adds minimal new meaning beyond what the schema already provides, so the baseline score of 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 clearly states the tool bans one or more Clerk users and prevents them from signing in, which is a specific verb+resource combination. It distinguishes from sibling tools like clerk.unban_users and clerk.delete_user by focusing on the ban action and its immediate effect.

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 provides explicit guidance to call clerk.get_connected_accounts first and explains how to target a specific connection or use the default account. It does not explicitly compare with alternatives like unban_users or delete_user, but the context is clear and actionable.

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.