Skip to main content
Glama

List API Tests

list_api_tests
Read-onlyIdempotent

List your API tests one page at a time, each with its current configuration and health state (UP, DOWN, RATE_LIMITED or PAUSED) and consecutive-failure count. Use this to see what is being watched. 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). The result is a page, not the full list: 'apiTests' holds at most 'size' tests (default 50, max 200), 'totalElements' is how many tests match the filters in total, and 'page' is the zero-based page you got. Fetch page+1 until page*size+apiTests.length reaches totalElements. 'upCount', 'downCount', 'rateLimitedCount' and 'pausedCount' always cover all of your tests regardless of filters or paging. Narrow with 'search' (name contains, case-insensitive) and/or 'state' instead of paging through everything when you are looking for specific tests or only for failing ones.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "list_api_tests"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageNoZero-based page number. Omit or 0 for the first page.
sizeNoTests per page, 1-200. Omit for 50.
stateNoOnly tests currently in this health state: 'UP', 'DOWN', 'RATE_LIMITED' or 'PAUSED'. Omit for all states.
searchNoOnly tests whose name contains this text (case-insensitive). Omit for all names.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / state / description
      Previous value: -"Only tests currently in this health state: 'UP', 'DOWN' or 'PAUSED'. Omit for all states."New value: +"Only tests currently in this health state: 'UP', 'DOWN', 'RATE_LIMITED' or 'PAUSED'. Omit for all states."
  2. Changed4 schema fields changed
    • addedInput schema / $schema
      Added value: +"https://json-schema.org/draft/2020-12/schema"
    • removedInput schema / additionalProperties
      Removed value: -false
    • addedInput schema / properties / page / format
      Added value: +"int32"
    • addedInput schema / properties / size / format
      Added value: +"int32"
  3. Changed4 schema fields changed
    • addedInput schema / properties / page
      Added value: +{
      +  "description": "Zero-based page number. Omit or 0 for the first page.",
      +  "type": "integer"
      +}
    • addedInput schema / properties / search
      Added value: +{
      +  "description": "Only tests whose name contains this text (case-insensitive). Omit for all names.",
      +  "type": "string"
      +}
    • addedInput schema / properties / size
      Added value: +{
      +  "description": "Tests per page, 1-200. Omit for 50.",
      +  "type": "integer"
      +}
    • addedInput schema / properties / state
      Added value: +{
      +  "description": "Only tests currently in this health state: 'UP', 'DOWN' or 'PAUSED'. Omit for all states.",
      +  "type": "string"
      +}
  4. Added
  5. Removed
  6. Added

TDQS

A4.1/5.0
Behavior5/5

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

Annotations already cover read-only/idempotent/non-destructive, but the description goes well beyond them: it defines each health state, clarifies that RATE_LIMITED is an HTTP 429 on the target and that the fix is customer-side (allowlist the Fixter prober), explains currentRevision semantics including null cases, and states that the count fields cover all tests regardless of filters. That is substantive behavioral context an agent cannot get from annotations.

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 purpose and paging model, then progressively adds state semantics and filtering advice; nearly every sentence carries information. It is dense and longer than typical, with a little restatement of schema defaults, but no filler.

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?

No output schema exists, so the description must carry the return shape — and it does: it names apiTests, totalElements, page, and the four count fields, and gives the exact termination rule for pagination. Combined with the state and revision explanations, an agent has everything needed to call and consume the result correctly.

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 coverage is 100%, so page, size, state and search are already documented with defaults and ranges; the description mostly restates that. Its added value is mainly around result interpretation (totalElements vs apiTests, counters ignoring filters) rather than parameter meaning, so baseline 3 is appropriate.

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 ('List your API tests') plus the scope ('one page at a time', 'what is being watched') and the shape of each item (configuration + health state). It never names a sibling such as get_api_test or get_api_test_runs, so the differentiation is left implicit even though it is structurally obvious.

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?

Gives concrete when-to-use guidance: 'Use this to see what is being watched' and 'Narrow with search and/or state instead of paging through everything when you are looking for specific tests or only for failing ones.' It stops short of naming alternative tools (e.g. get_api_test for a single test), so there is no explicit when-not-to-use clause.

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