Skip to main content
Glama

run_scan

Start an AI-visibility scan of a project now: every active tracked prompt on each of the project's engines that has a key, for the project's passes per prompt. It spends AI: checks on managed keys count against the workspace's Managed-AI allowance (premium engines three times), then as overage, pausing at the overage cap; checks on the workspace's own keys are billed by that provider. Requires write actions and "Allow actions that spend AI"; counts toward 20 assistant-started scans, briefs and rankings refreshes per workspace per day. Without confirm:true it returns a cost preview and starts nothing. The scan runs in the background; get_scan_status follows it. When the project is already scanning, the new scan is queued and starts when that one finishes (one queued scan per project; a second call updates it); a running scan is never stopped.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "run_scan"
  }
}

Input Schema

NameRequiredDescriptionDefault
confirmNotrue starts the scan. Omit to preview the cost. With confirm:true, also pass the preview's previewToken.
clientIdNoClient id — uses the AI-Visibility project its Overview opens in the app (the newest).
projectIdNoAI-Visibility project id.
previewTokenNoWith confirm:true: the previewToken from this tool's preview (valid 15 minutes, once, for exactly the previewed arguments).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • removedInput schema / additionalProperties
      Removed value: -false
  2. Changed1 schema field changed
    • changedInput schema / properties / confirm / description
      Previous value: -"Must be true to start the scan. Omit to preview the cost. With confirm:true, also pass the preview's previewToken."New value: +"true starts the scan. Omit to preview the cost. With confirm:true, also pass the preview's previewToken."
  3. First observed

TDQS

A4.6/5.0
Behavior5/5

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

With only readOnlyHint=false and destructiveHint=false from annotations, the description carries real weight and delivers: cost/overage model with a premium-engine multiplier, the overage cap pause, provider billing for own keys, a 20-scan-per-day quota, background execution, and the explicit guarantee that a running scan is never stopped. No contradictions with the annotations.

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?

Front-loads the action and its scope before cost and queuing details, and nearly every clause carries operational information. It is dense and runs long for a single paragraph, and the quota sentence bundles three distinct limits, but nothing is filler.

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?

No output schema exists, and the description compensates by describing what a preview returns (a previewToken to feed back) and how to observe progress via get_scan_status. For a cost-incurring, permission-gated mutation, the usage, billing, quota and queuing behavior are all 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?

Schema description coverage is 100%, so confirm, previewToken, clientId and projectId are already fully documented in the schema, including the 15-minute/one-use token constraint. The description restates the confirm/preview contract, which reinforces the flow but adds little beyond what structured data provides, so baseline 3 applies.

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?

Opens with a specific verb+resource ('Start an AI-visibility scan of a project now') and immediately scopes it ('every active tracked prompt on each of the project's engines that has a key'). It also names the follow-up sibling get_scan_status, so an agent can distinguish this action tool from the read tool it pairs with.

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?

Explicitly states the safe path ('Without confirm:true it returns a cost preview and starts nothing') versus the committing path, names the alternative for tracking progress ('get_scan_status follows it'), and explains the already-scanning case (queued, one queued scan per project). Prerequisites are named: write actions plus 'Allow actions that spend AI'.

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