Skip to main content
Glama

Enable API Test

enable_api_test
Destructive

Enable (resume scheduling) a paused API test. It will start running on its interval again and its state resets to UP. Returns the updated API test.

Input Schema

NameRequiredDescriptionDefault
apiTestIdYesId of the API test to enable

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 declare destructiveHint=true, readOnlyHint=false and non-idempotence, so the bar is lower, yet the description still adds real value: it says the test resumes on its interval and its state resets to UP, and that it returns the updated test (useful given no output schema). It does not say what happens if the test is already enabled or what errors occur.

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 tight sentences with zero waste: the action is front-loaded, followed by the state effect and return value. Nothing redundant.

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 one-parameter state-toggle mutation with no output schema, the description covers the action, the resulting scheduling behavior, the state transition to UP, and the return value. Only edge-case behavior (already-enabled test, auth requirements) 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?

Schema description coverage is 100% with a single well-documented apiTestId parameter, so the schema carries the burden. The description adds no syntax, format, or lookup guidance beyond 'a paused API test', which is the expected baseline.

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+resource ('Enable ... a paused API test') and clarifies the mechanism ('resume scheduling'), which keeps it distinct from create_api_test and update_api_test. It never names the obvious counterpart disable_api_test to sharpen the contrast, so it falls short of full sibling differentiation.

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 phrase 'a paused API test' implies the precondition for use, but there is no explicit when-to-use/when-not guidance and no mention of disable_api_test or other state-management siblings. Usage is inferable rather than stated.

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