Skip to main content
Glama
Sign In
JEStats Screaming Frog Audit

JEStats Screaming Frog Audit

by jestatsio
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

control_audit

Pause, resume, or cancel an audit job; resume reconciles the persisted checkpoint to avoid duplicate crawls, and cancel stops plugin work when the plugin owns the crawl.

Instructions

Pause, resume, or cancel an audit job. Resume reconciles the persisted checkpoint instead of blindly launching a duplicate crawl. Cancellation stops plugin work; native pause/control applies only where the plugin owns the crawl.

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": {
      "auditId": "<auditId>",
      "action": "<action>"
    },
    "name": "control_audit"
  }
}

Input Schema

NameRequiredDescriptionDefault
actionYes
auditIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.1

TDQS

A4.2/5.0
Behavior4/5

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

Annotations declare readOnlyHint=false, destructiveHint=false, openWorldHint=false, so the mutating-but-not-destructive framing is already carried; the description adds genuinely new behavior: resume reuses the persisted checkpoint instead of duplicating the crawl, cancel stops plugin work, and pause/control is only native where the plugin owns the crawl. It does not state reversibility or permission requirements, but the added operational caveats are substantive.

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 tight sentences, front-loaded with the action set and then the non-obvious semantics. Every sentence adds information; none restates the enum or name.

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 two-parameter, no-output-schema control tool, the definition covers what each action does and the important edge case (pause only where the plugin owns the crawl). Return/result behavior after cancel or resume is unstated, but the core invocation-relevant context is present.

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 0%, so the description carries the burden. It explains the semantics of the action values (especially resume's checkpoint reconciliation and cancel's effect on plugin work), but says nothing about auditId beyond what the UUID format/pattern already implies, leaving one of two parameters undocumented.

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 set of verbs (pause, resume, cancel) against a specific resource (an audit job), so the agent immediately knows this is lifecycle control rather than the sibling query tools like audit_status or list_audits. It is cleanly distinguishable from start_audit, which the actions do not overlap.

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?

Gives real guidance on each action: resume reconciles the persisted checkpoint rather than launching a duplicate crawl, and native pause/control applies only where the plugin owns the crawl. It does not explicitly route the agent between this tool and siblings (e.g. use audit_status to check state first), so it falls short of full when/when-not guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools