Skip to main content
Glama

Get API Test

get_api_test
Read-onlyIdempotent

Fetch a single API test by id, including its full configuration and current health state (UP, DOWN, RATE_LIMITED or PAUSED) and consecutive-failure count. For MCP tests, 'currentRevision' is the protocol revision the latest run spoke; null until the first run, and always null for an UPTIME test. RATE_LIMITED means the target is rate limiting the monitor (HTTP 429), not that it is down; the fix is on the customer's side (allowlist the Fixter prober).

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": {
      "apiTestId": "<apiTestId>"
    },
    "name": "get_api_test"
  }
}

Input Schema

NameRequiredDescriptionDefault
apiTestIdYesId of the API test to fetch

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / $schema
      Added value: +"https://json-schema.org/draft/2020-12/schema"
    • removedInput schema / additionalProperties
      Removed value: -false
  2. Added
  3. Removed
  4. Added

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive, closed-world), and the description adds real semantic context on top: what each health state means, that RATE_LIMITED is an HTTP 429 caused by the target rather than a monitor failure, and that the remedy is customer-side allowlisting. The currentRevision null semantics (null before the first run, always null for UPTIME tests) further prevent misreading.

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?

The core action and return contents are front-loaded in the first sentence, with the state semantics following. It is somewhat dense and the currentRevision clause is a long parenthetical, but every sentence carries information an agent could act on.

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

Completeness5/5

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

With no output schema available, the description carries the full burden and does so: it names the return contents, defines each enum-like health value, and explains currentRevision edge cases for MCP versus UPTIME tests. For a one-parameter read-by-id tool with full annotation coverage, nothing material 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?

There is a single required parameter, apiTestId, and schema description coverage is 100%, so the schema already documents it fully. The description adds no syntax, format, or sourcing detail (e.g. where to obtain the id) beyond 'by 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 ('Fetch a single API test by id') and enumerates what comes back: full configuration, health state, consecutive-failure count. The 'single... by id' framing implicitly separates it from list_api_tests and the runs/destinations siblings, though no sibling is named explicitly.

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?

Usage is only implied: an agent is expected to infer 'use this once you have an apiTestId, rather than calling list_api_tests.' There is no explicit when-to-use statement and no routing to get_api_test_runs or get_api_test_destinations for run history or notification targets. The value-interpretation guidance (RATE_LIMITED is not DOWN) is helpful, but that is interpretation, not selection 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