Skip to main content
Glama

get_sweep

Read-onlyIdempotent

Where one sweep has got to: its status and how many of its runs have finished. This is how you answer 'is it done yet' -- read it when the person asks, not on a loop, because the engine works for minutes or hours and a second look a moment later says the same thing. Results can be read while it is still running; the rows that exist are real.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "experiment_id": "<experiment_id>"
    },
    "name": "get_sweep"
  }
}

Input Schema

NameRequiredDescriptionDefault
experiment_idYesThe sweep, as create_sweep returned it.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.9/5.0
Behavior4/5

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

The annotations already establish read-only, idempotent, non-destructive behavior, and the description adds useful non-obvious context about long-running execution and safe polling. It also clarifies that results are readable while the sweep is still running and that existing rows are real, which meaningfully improves behavioral transparency.

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?

The description is front-loaded with the core purpose and then adds practical usage guidance. It is mostly efficient, though the polling explanation is slightly conversational and could be tightened.

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 one-parameter status tool with annotations covering safety and no output schema, the description provides enough context to invoke it correctly. It could be slightly more explicit about the exact status values or counts returned, but the core behavior is adequately covered.

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?

There is one parameter and schema description coverage is 100%, so the schema already documents experiment_id sufficiently. The description implies the parameter by referring to 'one sweep' but does not add format or sourcing detail beyond the schema's note that it is the sweep returned by create_sweep.

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?

The description clearly states a specific purpose: retrieving one sweep's status and finished-run count. It distinguishes the one-sweep scope from list-oriented siblings, but does not explicitly name alternatives such as get_sweep_run or find_sweep_runs, 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 Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives clear usage guidance: read it when the person asks, not in a polling loop, and explains why polling is unnecessary. It does not name alternative tools for run-level details or listing, so the when-to-use guidance is strong but not exhaustive.

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.