Skip to main content
Glama

delete_user_invite

Destructive

Remove a pending user invitation and revoke its invite link without affecting existing users.

Instructions

Delete a pending invite and revoke its invite link. This does not affect existing users; use delete_user for full user removal.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
invite_idYesThe invite ID to delete

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
okYesWhether the tool call succeeded and returned structured data
dataNoStructured success payload when ok is true
errorNoStructured error payload when ok is false

Implementation Reference

  • The actual handler function that performs the delete operation. It sends a DELETE request to '/admin/users/invites/{inviteId}', awaiting the response, and returns { success: true }.
    async deleteUserInvite(inviteId: string): Promise<{ success: boolean }> {
    	await this.delete(
    		`/admin/users/invites/${this.encodePathSegment(inviteId)}`,
    	);
    	return { success: true };
    }
  • Zod input schema for delete_user_invite. Defines a single required parameter: invite_id (string) describing the invite ID to delete.
    deleteUserInvite: {
    	invite_id: z.string().describe("The invite ID to delete"),
    },
  • Registers the 'delete_user_invite' tool on the MCP server with a description, schema, and handler that delegates to service.users.deleteUserInvite().
    // Phase 1: Delete user invite tool
    server.tool(
    	"delete_user_invite",
    	"Delete a pending invite and revoke its invite link. This does not affect existing users; use delete_user for full user removal.",
    	USERS_TOOL_SCHEMAS.deleteUserInvite,
    	async (params) => {
    		await service.users.deleteUserInvite(params.invite_id);
    		return {
    			content: [
    				{
    					type: "text",
    					text: JSON.stringify(
    						{
    							message: `Successfully deleted invite ${params.invite_id}`,
    							success: true,
    						},
    						null,
    						2,
    					),
    				},
    			],
    		};
    	},
    );
Behavior4/5

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

Annotations include destructiveHint=true, so the safety profile is already indicated. The description adds that the invite link is revoked and that existing users are unaffected, providing extra context beyond the annotations.

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?

Two concise sentences with no redundant information. Every phrase adds value, and the structure is efficient.

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 simple delete tool with one parameter and an existing output schema, the description covers purpose, scope, and exclusions thoroughly, leaving no ambiguity.

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% with one parameter (invite_id) already documented. The description does not elaborate on parameter meaning beyond schema, but the schema itself is clear.

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?

Clearly states 'Delete a pending invite and revoke its invite link,' specifying the action and resource. Distinguishes from 'delete_user' by noting it does not affect existing users, helping the agent differentiate among sibling tools.

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?

Explicitly provides when to use (delete pending invite) and when not to (does not affect existing users), and directs to 'delete_user' for full removal, offering a clear alternative.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/s-b-e-n-s-o-n/portkey-admin-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server