Skip to main content
Glama

test_integration

Idempotent

Test an integration's connection: Help sends its URL a challenge, and the URL must answer with the challenge signed with the integration's secret. Nothing about a customer is sent to a URL until it passes. handshake is "proved" when it worked; handshake_error says why not. 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>"
    },
    "name": "test_integration"
  }
}

Input Schema

NameRequiredDescriptionDefault
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 the annotations by describing the actual wire behavior (an outbound challenge to the URL, signed with the integration's secret) and by naming the two return fields, handshake and handshake_error, since no output schema exists to carry that. It also discloses the owner-only authorization requirement, which the annotations do not cover.

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?

Front-loaded with the purpose and mechanism, then the outcome fields, then the permission note — a sensible information order with no filler. The phrasing around "`handshake` is \"proved\" when it worked" is slightly awkward and could be plainer.

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 one-parameter action tool with no output schema, the description covers the mechanism, the successful and failed outcomes, and the auth requirement. It leaves open what state the integration is left in after a failure (e.g., whether it is marked unverified or disabled), but nothing essential 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?

The schema documents the single parameter at 100% coverage, including its provenance ("from list_integrations"). The description adds nothing about integration_id, which is fine — the schema already does the work, 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 ("Test an integration's connection") and immediately explains the mechanism — sending a signed challenge to the integration's URL. An agent knows exactly what happens. It does not mention the near-identical sibling test_integration_address, so differentiation is left to the name alone.

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 line "Nothing about a customer is sent to a URL until it passes" gives a clear operational condition: test before trusting the integration with real customer traffic. The "Owner only" clause flags the permission gate. There is no explicit when-not or pointer to test_integration_address, so it stops short of full routing guidance.

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