Skip to main content
Glama

update_egress_allowlist_entry

Destructive

Change an organisation's egress allowlist domain or description by entry ID; omitted fields stay unchanged, and a null description clears it. Use it to adjust trusted outbound destinations.

Instructions

Change an organisation egress allowlist domain or description, potentially changing trusted outbound destinations. Inspect get_egress_allowlist_entry first. Omitted fields stay unchanged; description null clears it. At least one changed field is required. Returns Portkey's acknowledgement; requires organisation permission.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "id": "<id>"
    },
    "name": "update_egress_allowlist_entry"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesEgress allowlist entry UUID from list_egress_allowlist or create_egress_allowlist_entry
domainNoExact hostname, IPv4/IPv6 literal (optionally bracketed), or *. wildcard. No scheme, path, credentials, or port. Portkey trims/lowercases it and rejects cloud-metadata destinations
descriptionNoOptional description (up to 500 characters); null clears it

Output 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

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.0.9
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • changedOutput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. Addedv1.0.8

TDQS

A4.7/5.0
Behavior5/5

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

Annotations already flag destructiveHint=true and idempotentHint=false; the description goes beyond them by spelling out partial-update semantics ('Omitted fields stay unchanged'), the null-clears-description rule, the minimum-one-field constraint, the permission requirement, and the acknowledgement return. It also warns that the change affects real outbound trust.

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?

Five short sentences, front-loaded with purpose and consequence, then prerequisite, then mutation semantics, then constraints. No filler and nothing repeated from structured fields.

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 3-parameter mutation with an output schema, the description covers purpose, prerequisite, partial-update rules, validation constraint, auth requirement, and return nature. Nothing an agent needs in order to call it correctly is missing.

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 coverage is 100%, so the baseline is 3 and the schema already documents the domain format and the null-clears behavior for description. The description still adds PATCH-style semantics for the whole call ('omitted fields stay unchanged; description null clears it') that the per-field schema does not convey as a call-level contract.

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 ('Change an organisation egress allowlist domain or description') and immediately frames the consequence ('trusted outbound destinations'). The sibling set contains list/create/get/delete_egress_allowlist_entry, and this description makes clear this is the mutation-in-place variant.

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?

'Inspect get_egress_allowlist_entry first' gives an explicit prerequisite step, and 'At least one changed field is required' rules out a null-op call. It does not explicitly contrast with create_egress_allowlist_entry or delete_egress_allowlist_entry, so it stops short of full when/when-not routing.

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

Deploy Server

Other Tools