Skip to main content
Glama

Disable API Test

disable_api_test
DestructiveIdempotent

Disable (pause) an API test so it stops running on its schedule. Its state becomes PAUSED and no new runs are recorded until you enable_api_test it again. Returns the updated API test.

Input Schema

NameRequiredDescriptionDefault
apiTestIdYesId of the API test to disable

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

A4.2/5.0
Behavior4/5

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

Annotations already declare destructiveHint=true, idempotentHint=true, and readOnlyHint=false. The description goes beyond them by naming the resulting state (PAUSED), stating that no new runs are recorded, and clarifying the change is reversible via enable_api_test — useful for judging the 'destructive' hint. It does not describe error behavior or permission requirements.

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?

Three compact sentences, front-loaded with the action and its immediate effect. Every sentence adds a distinct fact (what it does, the state change and persistence, the return value) with no repetition of the tool name or title.

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 state-toggle with no output schema, the description covers the effect, reversibility, and return value, and annotations cover idempotency and destructiveness. Missing only failure/permission behavior (e.g., unknown id, already-paused test), which is a minor gap given the idempotent hint.

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?

With 100% schema description coverage and a single required apiTestId parameter, the schema already carries full parameter semantics ('Id of the API test to disable'). The description adds no format, sourcing, or lookup guidance beyond that, so the baseline of 3 applies.

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?

States a specific verb (Disable), clarifies it means pause, names the exact resource (an API test), and describes the resulting effect (stops running on its schedule, state becomes PAUSED). This distinguishes it from enable_api_test, delete_api_test, and update_api_test without needing to open any schema.

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 clear context: use this to stop a test from running on its schedule, and notes the reverse path via enable_api_test. It implies a contrast with delete_api_test (pause vs. permanent removal) but never states that alternative explicitly, nor any precondition such as the test already existing or being enabled.

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