Skip to main content
Glama

update_virtual_key

Update a virtual key's name, secret, note, or limits. Changes apply immediately to downstream prompts and configs.

Instructions

Update a virtual key's name, secret, note, or limits. Rotating the key takes effect immediately, and limit changes apply to downstream prompts and configs using this slug. Returns the updated name, slug, and status.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
slugYesThe slug of the virtual key to update
nameNoNew display name for the key
keyNoNew provider API key value
noteNoNew note or description
credit_limitNoNew credit limit for usage
alert_thresholdNoNew alert threshold percentage (0-100)
rate_limit_rpmNoNew rate limit in requests per minute

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 MCP tool handler for 'update_virtual_key'. Receives params (slug, name, key, note, credit_limit, alert_threshold, rate_limit_rpm), calls service.keys.updateVirtualKey, and returns the updated key's name, slug, and status.
    // Phase 2: Update virtual key tool
    server.tool(
    	"update_virtual_key",
    	"Update a virtual key's name, secret, note, or limits. Rotating the key takes effect immediately, and limit changes apply to downstream prompts and configs using this slug. Returns the updated name, slug, and status.",
    	KEYS_TOOL_SCHEMAS.updateVirtualKey,
    	async (params) => {
    		const result = await service.keys.updateVirtualKey(params.slug, {
    			name: params.name,
    			key: params.key,
    			note: params.note,
    			usage_limits: buildUsageLimits({
    				credit_limit: params.credit_limit,
    				alert_threshold: params.alert_threshold,
    			}),
    			rate_limits: buildRateLimitsRpm(params.rate_limit_rpm),
    		});
    
    		return {
    			content: [
    				{
    					type: "text",
    					text: JSON.stringify(
    						{
    							message: `Successfully updated virtual key "${params.slug}"`,
    							name: result.name,
    							slug: result.slug,
    							status: result.status,
    						},
    						null,
    						2,
    					),
    				},
    			],
    		};
    	},
    );
  • Input validation schema for update_virtual_key using Zod: slug (required), name, key, note, credit_limit, alert_threshold, rate_limit_rpm (all optional).
    updateVirtualKey: {
    	slug: z.string().describe("The slug of the virtual key to update"),
    	name: z.string().optional().describe("New display name for the key"),
    	key: z.string().optional().describe("New provider API key value"),
    	note: z.string().optional().describe("New note or description"),
    	credit_limit: z.coerce
    		.number()
    		.positive()
    		.optional()
    		.describe("New credit limit for usage"),
    	alert_threshold: z.coerce
    		.number()
    		.min(0)
    		.max(100)
    		.optional()
    		.describe("New alert threshold percentage (0-100)"),
    	rate_limit_rpm: z.coerce
    		.number()
    		.positive()
    		.optional()
    		.describe("New rate limit in requests per minute"),
    },
  • Registration of the tool name 'update_virtual_key' with its schema KEYS_TOOL_SCHEMAS.updateVirtualKey on the McpServer.
    server.tool(
    	"update_virtual_key",
  • Service method that performs an HTTP PUT to /virtual-keys/{slug} with the update payload. This is the actual backend implementation called by the tool handler.
    async updateVirtualKey(
    	slug: string,
    	data: UpdateVirtualKeyRequest,
    ): Promise<VirtualKey> {
    	return this.put<VirtualKey>(
    		`/virtual-keys/${this.encodePathSegment(slug)}`,
    		data,
    	);
    }
  • Type definition for UpdateVirtualKeyRequest: optional name, key, note, usage_limits, and rate_limits.
    export interface UpdateVirtualKeyRequest {
    	name?: string;
    	key?: string;
    	note?: string | null;
    	usage_limits?: Partial<VirtualKeyUsageLimits>;
    	rate_limits?: VirtualKeyRateLimit[];
    }
Behavior4/5

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

Annotations indicate it's not read-only or destructive. The description adds that rotating the key is immediate and limit changes propagate to downstream prompts/configs, providing useful behavioral context beyond what annotations offer. It builds on the 'openWorldHint' by explaining downstream effects.

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 two sentences, front-loading the purpose and then adding key effects and return value. Every sentence adds value without redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With an output schema present, the description appropriately avoids repeating return details but mentions updated name, slug, and status. It covers the tool's effect on downstream resources, making it fairly complete for an update operation.

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?

The schema covers 100% of parameters with descriptions, so the description's mention of 'name, secret, note, or limits' adds minimal new information. It does not clarify edge cases or constraints beyond what the schema provides.

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 'Update a virtual key's name, secret, note, or limits,' using a specific verb ('Update') and resource ('virtual key'). It distinguishes from siblings like create_virtual_key and delete_virtual_key by focusing on modification.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides context by noting that key rotation takes effect immediately and limit changes affect downstream, but it does not explicitly state when to use this tool versus alternatives or when not to use it. No exclusions or comparisons are provided.

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