Skip to main content
Glama

scrapewise_stop_scraper

DestructiveIdempotent
        Stops a scraper that is currently in RUNNING state — sets `lastRunState` to
        STOPPED and persists. Partial scraped data already written to the group's
        collection is kept (use scrapewise_delete_scraper_data on the run's
        scraperJobStatusId to clear it). Idempotent for the already-stopped case:
        calling on a scraper whose state is anything other than RUNNING is a silent
        no-op (the if-check skips the save). NOT idempotent for missing scraper id —
        see Error Handling.

        Args:
          - id (string, path param, required): the scraper's MongoDB ObjectId. Get
            from scrapewise_get_scraper_list (look for `lastRunState=RUNNING`).

        HTTP methods: the route answers BOTH `GET /api/scraper/{id}/stop` and
        `POST /api/scraper/{id}/stop`. POST is the one the 409 `SCRAPER_RUN_ACTIVE`
        guidance names, and it used to answer 405 (see [stopScraperViaPost]); GET is
        kept for every client written against the older shape.

        Returns:
          200 OK with empty body. The state transition completes synchronously before
          the response is returned, so a follow-up scrapewise_get_scraper will read
          the new STOPPED state. A job that had not started yet (PENDING) is
          terminalised in the same call, so the scraper is immediately deletable.

        Examples:
          - Use when: "cancel the running scraper {id}" → id only
          - Use when: you suspect a runaway scrape and want to halt it before it
            consumes more proxy budget
          - Don't use when: you want to stop ALL scrapers in a group → use
            scrapewise_stop_scraper_group with the group id (one call vs N)

        Error Handling:
          - 400 (CustomerError envelope) if no scraper 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"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesthe scraper's MongoDB ObjectId. Get from scrapewise_get_scraper_list (look for `lastRunState=RUNNING`).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / id / description
      Added value: +"the scraper's MongoDB ObjectId. Get from scrapewise_get_scraper_list (look for `lastRunState=RUNNING`)."
  2. Added

TDQS

A4.5/5.0
Behavior5/5

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

Goes well beyond the annotations: discloses that partial scraped data is retained (and which sibling clears it), that the transition is synchronous so a follow-up read shows STOPPED, that a PENDING job is terminalised making the scraper immediately deletable, and that already-stopped calls are a silent no-op. Error codes 400/401/500 are spelled out, which annotations alone never convey.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Well front-loaded and sectioned, but the HTTP methods paragraph (GET vs POST route history, code-reference bracket [stopScraperViaPost]) is internal transport trivia an MCP caller cannot act on and consumes roughly a quarter of the text. The core semantics — state change, data retention, idempotency, errors — are the parts that earn their place.

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 one-parameter mutation with no output schema, the definition covers the return (200 with empty body), synchronous timing, idempotency in both the normal and missing-id cases, and the full error envelope. Nothing an agent needs to call it safely and interpret the result is absent.

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% and the single parameter's description in the schema is verbatim identical to the Args entry, so the description adds no new meaning about the id. It does confirm requiredness and the acquisition path (lastRunState=RUNNING), but that is already structured data — 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 and scope: stops a scraper 'currently in RUNNING state', naming the exact state transition (lastRunState → STOPPED) it performs. It is clearly separable from scrapewise_stop_scraper_group (bulk) and scrapewise_delete_scraper_data (data clearing), both of which are named.

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?

Explicit 'Use when' examples (cancel a specific running scraper, halt a runaway scrape before proxy spend) plus a concrete 'Don't use when' routing the bulk case to scrapewise_stop_scraper_group with a rationale (one call vs N). Nothing about selection is left to inference.

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.