Skip to main content
Glama

upsert_host_mapping

Create or update a DNS host mapping to route a domain to an IPv4/IPv6 target or block it. Provide an existing mapping ID to update; omit to create.

Instructions

Creates a native DNS Host mapping, or updates one when an existing mapping id is provided. Writes are applied immediately and do not require a second confirmation.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNoExisting Host mapping UUID; omit to create a new mapping
actionNoMap the domain to target, or block it (default map)
domainYesASCII domain name to match, for example api.example.com
targetNoIPv4 or IPv6 target; omit for a block mapping
commentNoOptional operator comment; use an empty string to clear it
enabledNoWhether the mapping is active (default true)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A3.9/5.0
Behavior3/5

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

With no annotations, the description carries the full burden. It usefully discloses that writes are immediate and require no second confirmation, which is meaningful for a mutation tool. However, it says nothing about idempotency, required permissions, what happens to omitted fields on update, or the effect of the block action, leaving substantial behavioral gaps.

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?

Two sentences that are front-loaded: the create/update behavior leads, and the immediacy caveat follows. Neither sentence is redundant and there is no filler.

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

Completeness3/5

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

For a six-parameter mutation tool with no annotations and no output schema, the description covers mode selection and write immediacy but omits the map-vs-block semantics, the fact that target is expected for map and omitted for block, and what the call returns. Those gaps are partially compensated by the unusually complete schema, keeping it at an adequate-but-incomplete level.

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 documents all six parameters (id, action, domain, target, comment, enabled) with defaults and constraints. The description adds only the id-presence rule, which the id's own schema description already states ('omit to create a new mapping'). Baseline 3 is appropriate.

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 states a specific verb and resource ('Creates a native DNS Host mapping, or updates one') and explicitly resolves the upsert ambiguity by tying the update branch to the presence of an existing mapping id. The 'Host mapping' resource is distinct from the other upsert siblings (upsert_rewrite_rule, upsert_module), so an agent can place it correctly without opening the 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?

It clearly states the condition that selects each mode: omit the id to create, provide an existing mapping id to update. This is real when-to-use guidance for an upsert. It stops short of naming alternatives for related intents (e.g., list_host_mappings to find an id, delete_host_mapping to remove one), so no explicit exclusion guidance is present.

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