Skip to main content
Glama

update_api_test

Replace the entire configuration of an existing API test (identified by apiTestId) with the supplied values — a full overwrite, not a partial patch, so pass every field you want to keep. Same parameters as create_api_test. Returns the updated API test and its state.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesHuman-readable name for the API test
typeYesAPI test type: 'HTTP' or 'MCP'
mcpUrlNoMCP only: the MCP server URL to probe
enabledYesWhether the API test is enabled (scheduled) or paused
httpUrlNoHTTP only: the http(s) URL to probe
mcpTierNoMCP only: assertion tier — HANDSHAKE, TOOLS_LIST or TOOL_CALL
retriesYesRetries per run before recording a failure (0-5)
httpBodyNoHTTP only: request body
toolNameNoMCP TOOL_CALL tier: name of the tool to invoke
apiTestIdYesId of the API test to update (from list_api_tests or get_api_test)
httpMethodNoHTTP only: request method — GET, POST, PUT, PATCH, DELETE or HEAD
httpHeadersNoHTTP only: request headers, as a name->value map
expectedToolsNoMCP TOOLS_LIST tier: tool names the server must advertise
statusPatternNoHTTP only: status matcher — '200', '2xx' or '20x'
headerMatchersNoHTTP only: response headers that must match, as a name->value map
timeoutSecondsYesPer-run timeout in seconds; positive and not exceeding intervalSeconds
intervalSecondsYesHow often to run the API test, in seconds (minimum 30)
mcpCredentialIdNoMCP only: id of a stored credential
failureThresholdYesConsecutive failing runs before the API test flips to DOWN (1-10)
httpCredentialIdNoHTTP only: id of a stored credential; omit for unauthenticated
maxLatencyMillisNoHTTP only: fail if slower than this many milliseconds
toolArgumentsJsonNoMCP TOOL_CALL tier: JSON object of tool arguments
bodyValidationTierNoHTTP only: body validation tier — NONE, VALID_JSON, JSON_SHAPE or EXACT_MATCH
mcpMaxLatencyMillisNoMCP only: fail if slower than this many milliseconds
bodyValidationSampleNoHTTP only: sample body for JSON_SHAPE/EXACT_MATCH tiers
mcpResultValidationTierNoMCP TOOL_CALL tier: result validation tier
mcpResultValidationSampleNoMCP TOOL_CALL tier: sample result for JSON_SHAPE/EXACT_MATCH

TDQS

A4.4/5.0
Behavior4/5

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

With no annotations, the description carries the burden of disclosing behavior. It explicitly states that this is a full overwrite, not a partial patch, which is a critical destructive trait, and it mentions the return value ('Returns the updated API test and its state'). This goes beyond a bare mutation description.

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?

The description is three sentences, front-loaded with the action, then a critical caveat, and a return-value note. Every sentence adds value—no filler or redundancy.

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?

The tool has 27 parameters and no output schema or annotations, so the description needs to add context beyond the schema. It covers the core behavior (full overwrite), parameter handling guidance, and return value. While it could include an example or error conditions, the provided context is sufficient for selecting and invoking the tool correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3. The description adds meaningful semantic guidance by clarifying that because this is a full overwrite, every field intended to be kept must be supplied. It also points to create_api_test for parameter details, helping the agent understand the parameter set without repetition.

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

Purpose5/5

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

The description uses a specific verb+resource ('Replace the entire configuration of an existing API test') and clearly distinguishes itself from sibling tools like create_api_test by focusing on updating an existing test. The scope is unambiguous.

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?

It provides clear context—this is for updating an existing API test via apiTestId—and emphasizes that it is a full overwrite, so users must pass all fields they want to keep. It does not explicitly list alternatives or when not to use it, but the context is clear and useful.

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.

TDQS

A3.8/5.0
Disambiguation2/5

Several tool pairs are near-duplicates, including three deprecated aliases (add_investigation_alert_channel vs add_alert_channel, list_investigation_alert_channels vs list_alert_channels, remove_investigation_alert_channel vs remove_alert_channel) that muddy the surface. Additionally, suppress_signal and create_ignore_rule both suppress alerting via different mechanisms, which could cause misselection despite detailed descriptions.

Naming Consistency4/5

The vast majority of tools follow a clear verb_noun snake_case pattern (create_api_test, list_issues, set_alert_rule_status). A few bare-noun tools (logs, spans, metrics) and the standalone verb correlate break the pattern slightly, but overall the naming is highly consistent and predictable.

Tool Count1/5

With 52 tools, this is on the extreme end of the calibration scale. Even accounting for the broad scope of an observability platform, the count is excessive and includes several deprecated redundancies that inflate it further.

Completeness5/5

The toolset provides comprehensive CRUD/lifecycle coverage across all major domains: alert rules (create, read, update, delete, status, delivery, preview), API tests (create, read, update, delete, run history, credentials), ignore rules and suppressions, issues with digest config, investigations with claim/read, channels, credentials, and rich query tools (logs, spans, metrics, SQL, traces, correlation). No obvious dead ends or missing core operations.

Resources