Skip to main content
Glama

Update a Route on a Domain Listener

update_domain_route
DestructiveIdempotent

Replace a single route entry on a port listener. Identify the existing route via prefix or regex (whichever it uses); the replacement route needs workloadLink and may omit optional matchers to match /. Returns the full updated domain JSON for inspection.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
orgNoOrganization slug.
routeYesRoute entry forwarding listener traffic to a workload. Minimal valid route: { "workloadLink": "//gvc/{gvc}/workload/{name}" }. All matchers are optional; omit prefix/regex to match /.
domainYesFully qualified domain name.
portNumberYesExisting listener port number to target.
routeIdentifierYesIdentifier for an existing route. Route identity is path matcher + host matcher (Joi uniqueRoute) — include the route's hostPrefix/hostRegex when it has one, or a same-path route on a different host is matched instead.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
okYes
dataNoThe full result. Read this, not only the summary.
detailsNo
summaryYes
nextStepsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / route / properties / caseInsensitive
      Added value: +{
      +  "description": "Optional. When true, prefix matches the path regardless of case. Prefix only; for a case-insensitive regex start it with (?i).",
      +  "type": "boolean"
      +}
  2. Changed25 schema fields changed
    • removedInput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • removedInput schema / additionalProperties
      Removed value: -false
    • removedInput schema / properties / domain / minLength
      Removed value: -1
    • changedInput schema / properties / org / description
      Previous value: -"Organization slug (lowercase kebab-case). NEVER guess — if the user has not named one, ask. On org-not-found, stop and ask; do not retry variants."New value: +"Organization slug."
    • removedInput schema / properties / org / maxLength
      Removed value: -63
    • removedInput schema / properties / org / minLength
      Removed value: -1
    • removedInput schema / properties / org / pattern
      Removed value: -"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$"
    • removedInput schema / properties / route / additionalProperties
      Removed value: -false
    • removedInput schema / properties / route / properties / headers / additionalProperties
      Removed value: -false
    • removedInput schema / properties / route / properties / headers / properties / request / additionalProperties
      Removed value: -false
    • removedInput schema / properties / route / properties / hostPrefix / pattern
      Removed value: -"^[0-9a-zA-Z-\\._]*$"
    • removedInput schema / properties / route / properties / mirror / items / additionalProperties
      Removed value: -false
    • removedInput schema / properties / route / properties / mirror / items / properties / workloadLink / minLength
      Removed value: -1
    • removedInput schema / properties / route / properties / prefix / pattern
      Removed value: -"^\\/[0-9a-zA-Z-\\._~\\/]*$"
    • removedInput schema / properties / route / properties / replacePrefix / pattern
      Removed value: -"^\\/[0-9a-zA-Z-\\._~\\/]*$"
    • removedInput schema / properties / route / properties / workloadLink / minLength
      Removed value: -1
    • removedInput schema / properties / routeIdentifier / additionalProperties
      Removed value: -false
    • changedInput schema / required
      Previous value: -[
      -  "org",
      -  "domain",
      -  "portNumber",
      -  "routeIdentifier",
      -  "route"
      -]New value: +[
      +  "domain",
      +  "portNumber",
      +  "routeIdentifier",
      +  "route"
      +]
    • removedOutput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • removedOutput schema / additionalProperties
      Removed value: -false
    • changedOutput schema / properties / data / description
      Previous value: -"The full machine-readable result — list rows, the resource object, query results. Read THIS, not just the summary."New value: +"The full result. Read this, not only the summary."
    • addedOutput schema / properties / details
      Added value: +{
      +  "type": "string"
      +}
    • removedOutput schema / properties / nextSteps / description
      Removed value: -"Recommended follow-up actions for this task, in order."
    • removedOutput schema / properties / ok / description
      Removed value: -"Whether the call succeeded."
    • removedOutput schema / properties / summary / description
      Removed value: -"One-line summary of the result."
  3. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true and idempotentHint=true, so the baseline is lower. The description adds value: it tells the agent the operation replaces (not merges) the route, notes the route identity is matcher-based, and states that the full updated domain JSON is returned for inspection, aiding verification after a destructive replace.

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?

Three tight sentences that front-load the action ('Replace...'), then the identification rule, then the return value. No filler.

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?

Given annotations cover the destructive/idempotent profile, the schema is fully documented, and an output schema exists (so return values need not be explained), the description is substantially complete. It could go further by naming the alternative tools to use when adding vs replacing.

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 description coverage is 100%, so the schema already carries parameter meaning and the baseline is 3. The description touches on routeIdentifier matchers and workloadLink, but adds no syntax 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?

States a specific verb ('Replace') and resource ('a single route entry on a port listener'), which clearly distinguishes it from siblings like update_domain, add_domain_route, and remove_domain_route. The use of 'Replace' rather than 'Update' signals the semantics precisely.

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?

Implied usage is clear from 'Replace a single route entry', but the description provides no explicit when-to-use vs add_domain_route/update_domain/remove_domain_route guidance or prerequisites. A reader can infer it, but nothing is spelled out.

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.