Skip to main content
Glama

Check an MCP gateway reaches its API

test_gateway_upstream
Read-onlyIdempotent

Check the gateway can reach the API's base URL with the credentials set on the dashboard. Makes one read-only request to the API.

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": {
      "gateway_id": "<gateway_id>"
    },
    "name": "test_gateway_upstream"
  }
}

Input Schema

NameRequiredDescriptionDefault
gateway_idYesFrom list_gateways.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive and closed-world, so the safety bar is low. The description still adds real value by bounding the side effect to exactly one request and clarifying that only the base URL is probed, not individual tools or data.

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 short sentences, front-loaded with the purpose and followed by the side-effect disclosure. Nothing redundant or padded.

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 single-parameter diagnostic tool with rich annotations and no output schema, the definition covers purpose, credential requirement and request cost. It only omits what a result looks like (success/failure signal, surfaced error), which is a minor gap.

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?

Only one parameter exists and schema coverage is 100%, with the schema itself noting 'From list_gateways.' The description adds no further meaning about gateway_id, so the 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: check that the gateway can reach the API's base URL. The scope limitation ('base URL', 'one request') implicitly distinguishes it from tool-level siblings like test_gateway_tool, but no sibling is named, so the differentiation is left to inference.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The mention of 'credentials set on the dashboard' implies a connectivity/diagnostic scenario, but the description never says when to choose this over test_gateway_tool or check_test_run, nor does it state prerequisites or what to do on failure. Usage is implied rather than instructed.

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