Skip to main content
Glama

Nopaque TotalPath

Get Test Sweep

getSweep
Read-onlyIdempotent

Get one sweep by id: name, description, testConfigId and profileIds. Use when: you have a sweep id (from listSweeps or a sweep run's sweepId). Read-only. Needs testing:read. Returns 404 if the sweep is not in your workspace.

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": {
      "id": "<id>"
    },
    "name": "getSweep"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesSweep identifier.

Output Schema

NameRequiredDescriptionDefault
idYes
nameYes
createdAtYes
createdByYes
updatedAtYes
profileIdsYesProfile IDs to sweep through (one run per profile).
descriptionNo
workspaceIdYes
testConfigIdYesThe single TestConfig to run against each profile.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive), so the description's marginal value is the required scope `testing:read` and the 404 condition when the sweep is not in your workspace. Those are genuine behavioral disclosures beyond structured fields, though "Read-only" merely restates the annotation.

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 compact sentences with the resource and returned fields front-loaded, followed by the usage condition, auth scope and error case. No sentence is padding.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a single-parameter read with annotations and an output schema present, everything an agent needs is covered: what it returns, which id to supply, the required scope, and the failure mode. Return-value detail is correctly left to the output schema.

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?

With one parameter at 100% schema coverage the schema already defines `id` as a UUID sweep identifier; the description adds meaning by saying where such an id comes from (listSweeps or a run's sweepId). That is useful provenance rather than a repeat of the schema.

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 and resource ("Get one sweep by `id`") and enumerates the returned fields (name, description, testConfigId, profileIds), which distinguishes it from listSweeps and getSweepRun without opening a 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?

Explicit "Use when: you have a sweep id" plus the provenance of that id (from listSweeps or a sweep run's sweepId) tells the agent how it arrives here rather than at the list tool. It stops short of an explicit when-not or a named alternative, which keeps it off a 5.

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.