Skip to main content
Glama

add_integration_address

Give one of the site's test domains its own address for an integration: a URL on that copy's own server, asked about that domain's test tickets. The answer includes the address's own secret, shown this once: put it in that server's configuration now (never in a page or a repository), then call test_integration_address. Owner only.

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": {
      "integration_id": "<integration_id>",
      "test_domain": "<test_domain>",
      "url": "<url>"
    },
    "name": "add_integration_address"
  }
}

Input Schema

NameRequiredDescriptionDefault
urlYesThe URL on that copy's own server that Help asks about its users (https).
test_domainYesOne of the site's test domains, from list_integration_addresses.
integration_idYesThe integration's id (a uuid), from list_integrations.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior5/5

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

Goes well beyond annotations: annotations only say non-read-only, non-idempotent, non-destructive; the description adds that the returned secret is shown exactly once, must be placed in the server config immediately, and must never go in a page or repository. That is exactly the irreversible, security-critical behavior an agent needs and cannot infer from structured fields.

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?

Two sentences, front-loaded with the action and followed by the one-time-secret warning and the required follow-up call. Every clause carries information, though the first sentence is a long chained clause that could be split for faster scanning.

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?

No output schema exists, and the description compensates by stating the answer contains the address's own secret shown once. Combined with prerequisites, owner restriction, and the follow-up test step, it is nearly complete; it does not address failure cases such as a domain already having an address.

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 all three parameters (url, test_domain, integration_id) are already documented with their sources (list_integration_addresses, list_integrations). The description adds scope semantics ('URL on that copy's own server') but no format or validation detail beyond the schema, so baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource (give a test domain its own address for an integration) and scopes it to 'test domains' plus 'that domain's test tickets', which separates it from list_integration_addresses, remove_integration_address, and test_integration_address. The phrasing is dense and slightly indirect ('Give ... its own address'), but an agent can identify the operation 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?

Explicitly states the prerequisite ('one of the site's test domains'), the post-condition ('then call test_integration_address'), and an access constraint ('Owner only'). It doesn't name a when-not scenario or explicitly contrast with change_integration_url, but the sequencing plus owner restriction gives clear operational context.

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.

Resources