Skip to main content
Glama

Add to allowlist

add_to_allowlist
Idempotent

Use when the user wants to let one more person in, invite a client, or share it with the team. Adds email and/or domain entries to a private site's allowlist WITHOUT removing anyone already on it; use this to share with more people. Entries already present are left untouched (the call is idempotent), and everyone previously allowed keeps their access. To replace the entire list instead, use set_allowlist; to take someone off, use remove_from_allowlist. Pro only; on a plan without it the refusal names the plan, and where one lapsed, how to get it back. The site must be allowlist (private); make it private first with set_visibility if it is public. Each newly-added email receives an invite email; the optional message is included in it as a personal note from the owner.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
messageNoOptional personal note included in the invite email sent to each newly-added email entry (max 1000 characters). Not persisted; domain entries get no email.
site_idYesThe id of the site to update
allowlistYesEntries to add; appended to the existing allowlist, duplicates ignored
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.6/5.0
Behavior4/5

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

Annotations already declare idempotentHint=true, destructiveHint=false, and readOnlyHint=false. The description reinforces idempotency and adds critical side effects: invite emails sent to new entries, the optional message inclusion, and the Pro-plan refusal behavior. It also clarifies that domain entries receive no email. This goes beyond annotations and does not contradict them.

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 long but every sentence carries information: use cases, behavior, alternatives, prerequisites, plan requirements, and side effects. It front-loads the core purpose before diving into details. No filler or repetition; it is dense but well-structured.

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?

The tool is a write operation with multiple nuances: idempotency, invite emails, plan gating, and a private-site prerequisite. The description covers all of them, plus alternatives. No output schema exists, but for a mutation tool this is acceptable; the description provides everything an agent needs to decide whether and how to call it correctly.

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 100%, so baseline is 3. The description adds meaning beyond the schema: it explains that `message` is a personal note in the invite email (schema only says optional), that `allowlist` entries are appended and duplicates ignored, and that domain entries don't get emails. It also clarifies the `site_id` must point to a private site. This is useful semantic enrichment.

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: 'Adds email and/or domain entries to a private site's allowlist.' It distinguishes itself from set_allowlist (replace) and remove_from_allowlist (take off), so an agent can tell them apart. The phrase 'WITHOUT removing anyone already on it' makes the scoped behavior unambiguous.

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?

Gives explicit triggers ('when the user wants to let one more person in, invite a client, or share it with the team') and names the exact alternatives: 'use `set_allowlist`' for replacement and 'use `remove_from_allowlist`' to remove. It also states the prerequisite (site must be private) and the Pro-plan restriction, leaving no ambiguity about when to invoke.

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.