Control Plane

Add a Route to a Domain Listener

add_domain_route

Idempotent

Append a route entry to an existing port listener. Minimal route is {workloadLink}; omit prefix/regex to match /. Routes are matched by prefix (default) or regex; the new route must not collide with an existing one. Use update_domain_route to replace an existing entry.

Input Schema

TableJSON Schema

Name	Required	Description
`org`	No	Organization slug.
`route`	Yes	Route entry forwarding listener traffic to a workload. Minimal valid route: { "workloadLink": "//gvc/{gvc}/workload/{name}" }. All matchers are optional; omit prefix/regex to match /.
`domain`	Yes	Fully qualified domain name.
`portNumber`	Yes	Existing listener port number to target.

Output Schema

TableJSON Schema

Name	Required	Description
`ok`	Yes
`data`	No	The full result. Read this, not only the summary.
`details`	No
`summary`	Yes
`nextSteps`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedOct 1, 2026

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"
+}

Changed24 schema fields changedSep 30, 2026
- 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
```
- changedInput schema / required
```
Previous value: -[
-  "org",
-  "domain",
-  "portNumber",
-  "route"
-]New value: +[
+  "domain",
+  "portNumber",
+  "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."
```
First observedJun 28, 2026

TDQS

A4.2/5.0

Behavior4/5

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

Annotations cover the safety profile (non-read-only, open-world, idempotent, non-destructive), so the description is free to add matching semantics: prefix-by-default vs regex matching, and the collision constraint that governs whether the call succeeds. It still omits any note on auth requirements or side effects on live traffic, keeping it short of a 5.

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: action first, minimal valid payload and matching semantics second, alternative tool last. No filler and nothing buried.

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?

An output schema exists, so return values need not be described, and the deep nested route schema is fully documented. The description supplies the essential routing/collision behavior for a moderately complex mutation tool; only permission/error context is missing.

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 nested route object and every matcher are already documented in the schema. The description's 'minimal route is {workloadLink}; omit prefix/regex to match /' restates what the schema already says, adding little beyond the baseline.

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?

Opens with a precise verb+resource+scope: 'Append a route entry to an existing port listener.' This clearly separates it from add_domain_port (listener creation) and update_domain_route (replacement), which the description names directly.

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?

Explicitly routes the agent to update_domain_route for replacing an existing entry, and states the precondition that the new route must not collide with an existing one. It does not, however, spell out prerequisites such as required permissions or that the listener must already exist.

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

All Control Plane tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.