Skip to main content
Glama

Pause or activate a Retrieve agent

claix.agents.pause
Idempotent

Pause or activate a Retrieve agent (POST /agents/pause/{agent_id}). Body: { status: "paused"|"active" }.

Input Schema

NameRequiredDescriptionDefault
statusYesSet "paused" to disable or "active" to re-enable.
api_keyNoAPI key secreta de Claix. Ejemplo: claix_sk_abc123.... Opcional si la conexión MCP envía x-api-key en cabecera HTTP (recomendado en Smithery/Cursor).
agent_idYesUUID of the agent to edit or pause.

Output Schema

NameRequiredDescriptionDefault
dataNoJSON payload from the Claix API (extracted records, schema list, or Excel export metadata).
errorNoHuman-readable error message when success is false.
successYesTrue when Claix returned a successful response. False when isError is set on the tool result.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare the full safety profile (readOnlyHint=false, idempotentHint=true, destructiveHint=false), so the bar is lower. The description restates the body shape already present in the schema but adds no behavioral context such as whether pausing interrupts in-flight retrievals, whether an API key is required, or what happens to a paused agent's data.

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 short clauses with zero filler; the action and endpoint are front-loaded and the body shape follows immediately. Nothing in the sentence is redundant padding.

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 simple state-toggle with full schema coverage and an output schema (so return values need no explanation), the description covers what is needed to invoke it correctly. Only the absence of usage routing to sibling tools keeps it from being fully complete.

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%, so all three parameters (agent_id, status enum, api_key) are already documented in the schema. The description's body notation duplicates the status enum rather than adding syntax or format meaning beyond it, 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 pair (pause/activate) and the exact resource (a Retrieve agent), plus the underlying endpoint POST /agents/pause/{agent_id}. An agent can tell it is a state-toggle operation, though it does not explicitly distinguish itself from claix.agents.edit, the nearest sibling.

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 implied by the tool's purpose — call it to disable or re-enable an agent — but there is no explicit when-to-use guidance, no prerequisites, and no pointer to alternatives like claix.agents.edit for other agent modifications.

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