Skip to main content
Glama

Set allowlist

set_allowlist
Idempotent

Use when the user wants to set exactly who can view, replacing the current list. REPLACES a site's entire allowlist with the provided email and/or domain entries. This OVERWRITES the existing list, so anyone not in the entries you pass loses access. To add people without dropping the current ones, use add_to_allowlist instead; to take specific people off, use remove_from_allowlist. Pass an empty array to clear it. Each email that was not already on the list receives an invite email. Pro only, except that clearing the list works on every plan and on a public page.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
site_idYesThe id of the site to update
allowlistYesThe full set of entries to allow; replaces the existing allowlist
workspace_idNoOptional: the workspace to act in, from list_workspaces (the connection reaches the person's personal space and every workspace they are a member of). Required on a write when the connection reaches more than one workspace. Omit to act in the personal space (for an older single-workspace connection, the one workspace it was authorized for).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / workspace_id / description
      Previous value: -"Optional: the workspace (the personal space or a Pro workspace) to act in, from list_workspaces. Omit to act in the token owner's own account."New value: +"Optional: the workspace to act in, from list_workspaces (the connection reaches the person's personal space and every workspace they are a member of). Required on a write when the connection reaches more than one workspace. Omit to act in the personal space (for an older single-workspace connection, the one workspace it was authorized for)."
  2. First observed

TDQS

A4.9/5.0
Behavior5/5

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

The description surfaces important side effects the annotations do not: overwriting drops anyone not in the supplied list, new emails receive invite emails, and a Pro-plan restriction exists except for clearing. These are exactly the behaviors an agent needs to warn the user about. The overwrite language is consistent with idempotentHint=true and readOnlyHint=false, so there is no annotation contradiction.

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 front-loaded with the primary use case and every subsequent sentence adds a distinct, non-redundant fact: consequence of overwrite, alternatives, clearing behavior, invite emails, and plan limits. The capitalization of REPLACES/OVERWRITES emphasizes the critical warning without extra fluff.

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?

For a write operation with no output schema, the description covers selection, side effects, alternatives, edge cases, and plan/gating. An agent has everything it needs to decide to call set_allowlist and to explain the impact to the user.

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?

The schema already describes both key parameters at 100% coverage, so the baseline is 3. The description adds meaningful extra semantics: the allowlist parameter means the full replacement set, 'Pass an empty array to clear it,' and entries are email/domain kinds. This goes beyond the schema, though it does not need to restate site_id or workspace_id behavior.

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 precise verb and resource ('set ... allowlist') and immediately clarifies the core semantics: replacing the entire list with the provided entries. It also differentiates from siblings by naming add_to_allowlist and remove_from_allowlist as alternatives, so an agent cannot confuse them.

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?

Leads with the explicit trigger condition ('Use when the user wants to set exactly who can view, replacing the current list') and gives direct when-not instructions: prefer add_to_allowlist for additions and remove_from_allowlist for removals. Also covers the empty-array clear case and plan constraints.

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.