Skip to main content
Glama

inviteApplicants

Destructive

Invites shortlisted applicants to join the beta project as testers, sending each of them the beta invitation email. TWO-STEP TOOL: call it WITHOUT confirmationToken first — nothing is sent and you receive a preview plus a confirmationToken. Show the preview to the user; only after the user explicitly approves, call again with the SAME arguments plus the confirmationToken. Tokens are single-use and expire after a few minutes. Only applicants whose status is "shortlisted" can be invited — review them with reviewApplicants first. The beta project must be published, running, or paused; draft, finished, and archived beta projects refuse invitations. Each id is reported individually, so a partial failure still invites the rest. An applicant whose address cannot receive mail is still invited but carries emailDelivery "undeliverable" and is counted in undeliverable: the invitation exists, no email went out, and pinging will not help, so cancel it and invite the corrected address.

Input Schema

NameRequiredDescriptionDefault
matchIdsYesApplicant match ids from listApplicants (1 to 100). Only shortlisted applicants can be invited.
productIdYesID of the beta project to query. Get valid IDs from the listProducts tool.
confirmationTokenNoTwo-step confirmation token. Omit on the first call to receive a preview plus a token; then call again with the SAME arguments plus this token to execute. Single-use and short-lived.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Beyond readOnlyHint=false and destructiveHint=true, it discloses that the first call sends nothing, the executing call sends email, tokens are single-use and short-lived, and failures can be partial per applicant. The undeliverable case is especially transparent: the invitation persists without email, pinging will not help, and cancellation followed by reinvitation is needed.

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 purpose and confirmation workflow are front-loaded, followed logically by prerequisites, failure behavior, and edge-case handling. The single dense paragraph and lengthy final sentence reduce scanability, and a few details duplicate the schema, but nearly all of the content is operationally useful.

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 consequential mutation with no output schema, it supplies the dry-run/execute protocol, approval requirement, eligibility and project-state preconditions, token lifecycle, partial-failure semantics, and response-field interpretation for undeliverable mail. Explicitly naming cancelInvitations for the final remediation would be a small improvement, but the essential invocation context is present.

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?

Although schema coverage is 100%, the description adds operational constraints not captured there: productId must identify a published, running, or paused project, the second call must reuse the same arguments, and match ids can succeed or fail independently. Some shortlist and token details merely repeat the schema, so the added parameter value is not quite maximal.

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 opening sentence specifies the action, population, outcome, and side effect: shortlisted applicants are invited to become beta testers and receive invitation emails. This applicant-specific scope, reinforced by the reviewApplicants prerequisite, distinguishes it from inviteTesters and the list/review siblings.

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?

It explicitly requires a preview call, user review and approval, and a second call with identical arguments plus the token. It also states when invitations are refused based on applicant and project status, directs the agent to reviewApplicants first, and explains how to handle undeliverable addresses.

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