Skip to main content
Glama

scrapewise_stop_scraper_group

DestructiveIdempotent
        Stops every scraper in the given group that is currently RUNNING — iterates
        the group's scrapers and applies the same per-scraper stop semantics as
        scrapewise_stop_scraper to each. Idempotent at the per-scraper level:
        scrapers not in RUNNING state are silently skipped (the inner if-check
        short-circuits the save). Partial scraped data already written to the
        collections is kept; clear it with scrapewise_delete_scraper_data per
        scraperJobStatusId if needed. Use to cancel a group-wide run started via
        scrapewise_run_scraper_group, or to halt a stuck DAILY/WEEKLY-scheduled
        group mid-run.

        Args:
          - id (string, path param, required): the group's MongoDB ObjectId.

        Returns:
          200 OK with empty body. State transitions complete synchronously before
          the response is returned.

        Examples:
          - Use when: "stop everything in group {id}" → id only
          - Use when: the daily schedule fired and you want to halt it
          - Don't use when: you want to stop one specific scraper → use
            scrapewise_stop_scraper (cheaper, single-scraper write)

        Error Handling:
          - 400 (CustomerError envelope) if no group with the given id exists for
            this customer.
          - 401 Unauthorized.
          - 500 INTERNAL.

[runtime hint] This tool returns JSON-as-text — its response shape is dynamic (per-scraper itemsConfig, file binary, etc.) so the MCP outputSchema is omitted. Do not rely on the presence of any specific field in the response; treat the result as a string-or-object blob and parse defensively.

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": "scrapewise_stop_scraper_group"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesthe group's MongoDB ObjectId.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / id / description
      Added value: +"the group's MongoDB ObjectId."
  2. Added

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already declare destructive and idempotent, and the description adds non-obvious behavior beyond that: non-RUNNING scrapers are silently skipped, partial scraped data is retained and must be cleared with scrapewise_delete_scraper_data, and state transitions complete synchronously before the response. This is consistent with, and richer than, 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-loaded with the core action and scope, then structure into Args/Returns/Examples/Errors. Slight deduction for implementation trivia such as 'the inner if-check short-circuits the save', which does not help an agent decide or call.

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?

Covers action semantics, data-retention side effects, synchronous timing, return (empty body 200), and error cases including 400/401/500. Nothing needed to call it correctly is missing, and the runtime hint about a dynamic response is accounted for.

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?

Only one parameter with 100% schema coverage, so the schema already documents the Mongo ObjectId. The description adds only that it is a required path param, which is marginal; 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?

States a specific verb and resource (stop every scraper in a group), explicitly scopes it to currently RUNNING scrapers, and names the single-scraper sibling it is not. An agent can distinguish it from scrapewise_stop_scraper without opening either schema.

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?

Gives concrete use cases (cancel a group-wide run started via scrapewise_run_scraper_group, halt a stuck DAILY/WEEKLY schedule) plus an explicit 'Don't use when' routing to scrapewise_stop_scraper with a reason (cheaper, single-scraper write).

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.