Skip to main content
Glama

delete_virtual_key

Destructive

Delete a virtual key by its slug, removing it permanently. Confirm no active dependencies to avoid breaking prompts or configs.

Instructions

Delete a virtual key by slug. This is irreversible and will break prompts and configs that reference the slug, so confirm no active dependencies first. Returns success after removal.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugYesThe slug of the virtual key 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

  • Registration of the 'delete_virtual_key' MCP tool with its description, schema reference, and handler logic that calls the service method.
    // Phase 2: Delete virtual key tool
    server.tool(
    	"delete_virtual_key",
    	"Delete a virtual key by slug. This is irreversible and will break prompts and configs that reference the slug, so confirm no active dependencies first. Returns success after removal.",
    	KEYS_TOOL_SCHEMAS.deleteVirtualKey,
    	async (params) => {
    		const result = await service.keys.deleteVirtualKey(params.slug);
    		return {
    			content: [
    				{
    					type: "text",
    					text: JSON.stringify(
    						{
    							message: `Successfully deleted virtual key "${params.slug}"`,
    							success: result.success,
    						},
    						null,
    						2,
    					),
    				},
    			],
    		};
    	},
    );
  • Zod schema for the delete_virtual_key tool input: requires 'slug' string.
    deleteVirtualKey: {
    	slug: z.string().describe("The slug of the virtual key to delete"),
    },
  • Service method deleteVirtualKey that sends a DELETE request to /virtual-keys/{slug} and returns { success: true }.
    async deleteVirtualKey(slug: string): Promise<{ success: boolean }> {
    	await this.delete(`/virtual-keys/${this.encodePathSegment(slug)}`);
    	return { success: true };
    }
  • BaseService.delete helper used by deleteVirtualKey. Sends an HTTP DELETE with allowNoContent: true (handles 204 No Content).
    protected async delete<T>(path: string): Promise<T> {
    	return this.executeRequest<T>("DELETE", path, { allowNoContent: true });
    }
Behavior5/5

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

The description adds behavioral context beyond annotations: it explains the destructive impact ('break prompts and configs that reference the slug') and confirms the return behavior ('Returns success after removal'). No contradiction with 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 sentences with no filler. Front-loaded with verb and resource. Every sentence adds essential information.

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 one-parameter tool with an output schema, the description covers purpose, irreversibility, dependencies, and return. It is fully adequate.

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%, so the description adds minimal meaning beyond the schema attribute 'slug'. It confirms the slug is used for deletion, which is baseline value.

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 action ('Delete') and the resource ('virtual key') with the identifier ('by slug'). It distinguishes this from sibling tools like update_virtual_key by emphasizing irreversibility and dependency breaking.

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?

The description provides explicit guidance: 'confirm no active dependencies first' implies when to use (after verification) and a caution. It lacks explicit when-not-to-use but effectively advises against misuse.

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