Skip to main content
Glama

Start a scan

start_scan
Destructive

Run a scan: every active prompt (or the ones chosen) is asked of every connected assistant with web search on, and the answers are stored and analysed. Spends the workspace balance, so call estimate_scan first; budgetUsd stops the run once its price passes that amount. Needs an admin token. Returns the scan with its id; follow it with get_live_scan.

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": {
      "projectId": "<projectId>"
    },
    "name": "start_scan"
  }
}

Input Schema

NameRequiredDescriptionDefault
labelNoA name to tell this scan apart in list_scans.
queueNoWait for the worker instead of running at once: the answers arrive within hours and cost less (the queue price). Scheduled scans always do.
modelsNoAssistant key => model, e.g. {"openai":"gpt-5.4-mini"}. "chatgpt-app" and "gemini-app" take the answer as the app shows it.
sampleNoScan only N prompts, drawn at random.
repeatsNoHow many times to ask each question of each assistant (1–5). One answer is one draw; several show the spread, and the price follows.
categoryNoScan one category only — the cheapest useful scan.
budgetUsdNoStop the scan once its price passes this many US dollars.
projectIdYesThe project id, from list_projects.
promptIdsNoA hand-picked set. Empty = every active prompt.
providersNoWhich assistants to ask (google_aio = Google AI Overviews, google_ai_mode = Google AI Mode). Empty = every connected one the site allows; the workspace owner chooses those per site.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.7/5.0
Behavior5/5

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

Annotations declare destructive=true and not read-only, but the description adds the crucial business consequence: it spends the workspace balance, and budgetUsd caps the run once price passes the threshold. It also discloses the auth requirement (admin token) and the return shape (the scan with its id), going well beyond what the annotations convey.

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 dense sentences: what the scan does first, then cost/permission constraints, then the return value and follow-up tool. No filler, and the most consequential warning (spending balance) is placed early.

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 10-parameter, nested-object mutation with no output schema, the description covers the essentials an agent needs: cost implications, admin auth, budget capping, queue trade-off, and what comes back so the caller can chain to get_live_scan.

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 coverage is 100%, so all ten parameters are already documented in the schema. The description restates budgetUsd and the prompt/assistant scope but adds little parameter-level detail the schema doesn't already carry, so the baseline 3 is appropriate.

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?

The description states a specific verb and resource ("Run a scan") and immediately defines the operation: every active prompt asked of every connected assistant with web search on, answers stored and analysed. It is clearly distinguishable from estimate_scan (pricing) and get_live_scan (follow-up).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

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

It explicitly routes the agent: "call estimate_scan first" for cost, and "follow it with get_live_scan" after the returned scan id. It also states the admin-token prerequisite and the queue alternative for cheaper/slower runs, so the when and the how are both covered.

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