Skip to main content
Glama

Add cluster custom DNS zone

add_cluster_custom_dns_zone
Destructive

Declare that a cluster also serves a DNS zone with one of the organisation's DNS credentials (the twin of ankra cluster custom-dns-zones add), so the hosts of its Ingresses in that zone are published by Ankra. With provider 'cloudflare' the credential must be an organisation Cloudflare credential (ankra org cloudflare connect); Ankra checks with Cloudflare that its token reaches the zone with DNS edit before storing anything, and the zone's external-dns runs upsert-only: it creates and updates only the records it owns and never changes or deletes a record someone else made. Refused for a zone the cluster's generated zone already covers. Requires credentials.write.

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": {
      "zone": "<zone>",
      "credential_name": "<credential_name>"
    },
    "name": "add_cluster_custom_dns_zone"
  }
}

Input Schema

NameRequiredDescriptionDefault
zoneYesZone to serve, e.g. ankra.cloud or apps.example.com.
providerNoWhich kind of credential credential_name must be. Omit to accept whichever kind the name resolves to; name it to have a mismatch refused.
cluster_idNoUUID of the target cluster. Optional when a cluster is selected.
cluster_nameNoExact name of the target cluster. Optional when a cluster is selected.
credential_nameYesName of the organisation credential that publishes into the zone: a Cloudflare credential, a DNS webhook credential, or the Avura connection.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior5/5

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

Annotations only supply the flag triple (readOnly=false, destructive=true, idempotent=false); the description goes well beyond them with pre-flight validation (Ankra checks with Cloudflare that the token reaches the zone with DNS edit before storing anything) and post-write behavior (external-dns runs upsert-only, creates/updates only records it owns, never changes or deletes someone else's records). It also states the required auth scope, credentials.write, which no structured field carries.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Purpose and the CLI twin are front-loaded in the first clause, followed by validation, runtime semantics, and the refusal case in a logical order. The prose is dense — a single long paragraph with several nested parentheticals — but nearly every clause carries load-bearing information.

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?

For a mutating, non-idempotent operation with no output schema, the definition covers what an agent needs: prerequisites (credentials.write, org-level Cloudflare credential), validation behavior, the refusal condition, and the runtime record-ownership model. It stops short of describing the error surface or what a successful response contains, which is acceptable given no output schema exists.

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 all five parameters are already documented. The description nonetheless adds real meaning by coupling provider to credential_name: with 'cloudflare' the credential must be an organisation Cloudflare credential created via 'ankra org cloudflare connect', which the schema alone does not convey. It adds nothing for cluster_id vs cluster_name, which the schema handles.

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 opens with a specific verb and resource: 'Declare that a cluster also serves a DNS zone with one of the organisation's DNS credentials', and anchors it to the CLI twin 'ankra cluster custom-dns-zones add'. This is clearly distinguishable from list_cluster_custom_dns_zones and remove_cluster_custom_dns_zone without opening any schema.

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 gives a clear condition for use (publishing Ingress hostnames in an extra zone via Ankra) and one explicit when-not: it is 'Refused for a zone the cluster's generated zone already covers'. It also constrains credential choice per provider. It never names the sibling tools as alternatives, so it falls short of an explicit alternatives map.

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.