Skip to main content
Glama
apify

actors-mcp-server

Official
by apify
OverviewSchemaRelated ServersScoreDiscussions
TypeScript
Hybrid

Abort Actor run

abort-actor-run
DestructiveIdempotent

Abort a starting or running Actor run, forcefully or gracefully with a 30-second timeout. Returns updated run details to confirm the abort.

Instructions

Abort an Actor run that is currently starting or running. For runs with status SUCCEEDED, FAILED, ABORTING, ABORTED, or TIMED-OUT, this call has no effect. The results will include the updated run details after the abort request.

USAGE:

  • Use when you need to stop a run that is taking too long or misconfigured.

USAGE EXAMPLES:

  • user_input: Abort run y2h7sK3Wc

  • user_input: Gracefully abort run y2h7sK3Wc

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
runIdYesThe ID of the Actor run to abort.
gracefullyNoIf true, the Actor run will abort gracefully with a 30-second timeout.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
runIdYesActor run ID
statsNoRun statistics
statusYesRun status: READY | RUNNING | TIMING-OUT | TIMED-OUT | ABORTING | ABORTED | SUCCEEDED | FAILED
actorIdYesStable Apify Actor ID from the run record
summaryYesPast-tense summary of the run state
exitCodeNoActor process exit code; populated for terminal states (especially FAILED)
nextStepYesOne primary follow-up action with identifiers interpolated
storagesYesDataset and key-value store metadata, keyed by alias. "default" is always the primary entry.
actorNameNo"username/actor-name"
startedAtNoISO timestamp when the run started
finishedAtNoISO timestamp when the run finished (terminal states only)
statusMessageNoPass-through from Apify run.statusMessage
apifyConsoleUrlNoPersonalized Apify Console link to the run; present only for Console sessions

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. Changed2 schema fields changedv0.15.3
    • addedOutput schema / properties / storages / properties / datasets / required
      Added value: +[
+  "default"
+]
    • addedOutput schema / properties / storages / properties / keyValueStores / required
      Added value: +[
+  "default"
+]
  2. Addedv0.14.0
  3. Removedv0.13.0
  4. Changed14 schema fields changedv0.11.4
    • addedOutput schema / properties / storages / properties / datasets / additionalProperties / properties / apifyConsoleUrl
      Added value: +{
+  "description": "Personalized Apify Console link to the dataset; present only for Console sessions",
+  "type": "string"
+}
    • addedOutput schema / properties / storages / properties / datasets / additionalProperties / properties / fields
      Added value: +{
+  "description": "Dataset field paths in dot notation (e.g. [\"metadata.url\"])",
+  "items": {
+    "type": "string"
+  },
+  "type": "array"
+}
    • addedOutput schema / properties / storages / properties / datasets / additionalProperties / properties / id / description
      Added value: +"Dataset ID"
    • addedOutput schema / properties / storages / properties / datasets / additionalProperties / properties / inflatedBytes
      Added value: +{
+  "description": "Approximate uncompressed byte size of the dataset. Use with itemCount to pick limit/fields before fetching.",
+  "type": "number"
+}
    • addedOutput schema / properties / storages / properties / datasets / additionalProperties / properties / itemCount
      Added value: +{
+  "type": "number"
+}
    • addedOutput schema / properties / storages / properties / datasets / additionalProperties / properties / name
      Added value: +{
+  "type": "string"
+}
    • addedOutput schema / properties / storages / properties / datasets / additionalProperties / properties / title
      Added value: +{
+  "type": "string"
+}
    • removedOutput schema / properties / storages / properties / datasets / properties / default / properties / cleanItemCount
      Removed value: -{
-  "type": "number"
-}
    • addedOutput schema / properties / storages / properties / keyValueStores / additionalProperties / properties / apifyConsoleUrl
      Added value: +{
+  "description": "Personalized Apify Console link to the store; present only for Console sessions",
+  "type": "string"
+}
    • addedOutput schema / properties / storages / properties / keyValueStores / additionalProperties / properties / id / description
      Added value: +"Key-value store ID"
    • addedOutput schema / properties / storages / properties / keyValueStores / additionalProperties / properties / keyCount
      Added value: +{
+  "description": "Total number of keys (omitted when truncated)",
+  "type": "number"
+}
    • addedOutput schema / properties / storages / properties / keyValueStores / additionalProperties / properties / keys
      Added value: +{
+  "description": "Up to 50 key names",
+  "items": {
+    "type": "string"
+  },
+  "type": "array"
+}
    • addedOutput schema / properties / storages / properties / keyValueStores / additionalProperties / properties / name
      Added value: +{
+  "type": "string"
+}
    • addedOutput schema / properties / storages / properties / keyValueStores / additionalProperties / properties / title
      Added value: +{
+  "type": "string"
+}
  5. Changed1 schema field changedv0.11.3
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "properties": {
+    "actorId": {
+      "description": "Stable Apify Actor ID from the run record",
+      "type": "string"
+    },
+    "actorName": {
+      "description": "\"username/actor-name\"",
+      "type": "string"
+    },
+    "apifyConsoleUrl": {
+      "description": "Personalized Apify Console link to the run; present only for Console sessions",
+      "type": "string"
+    },
+    "exitCode": {
+      "description": "Actor process exit code; populated for terminal states (especially FAILED)",
+      "type": "number"
+    },
+    "finishedAt": {
+      "description": "ISO timestamp when the run finished (terminal states only)",
+      "type": "string"
+    },
+    "nextStep": {
+      "description": "One primary follow-up action with identifiers interpolated",
+      "type": "string"
+    },
+    "runId": {
+      "description": "Actor run ID",
+      "type": "string"
+    },
+    "startedAt": {
+      "description": "ISO timestamp when the run started",
+      "type": "string"
+    },
+    "stats": {
+      "description": "Run statistics",
+      "properties": {
+        "computeUnits": {
+          "type": "number"
+        },
+        "memMaxBytes": {
+          "type": "number"
+        },
+        "runTimeSecs": {
+          "type": "number"
+        }
+      },
+      "type": "object"
+    },
+    "status": {
+      "description": "Run status: READY | RUNNING | TIMING-OUT | TIMED-OUT | ABORTING | ABORTED | SUCCEEDED | FAILED",
+      "type": "string"
+    },
+    "statusMessage": {
+      "description": "Pass-through from Apify run.statusMessage",
+      "type": "string"
+    },
+    "storages": {
+      "description": "Dataset and key-value store metadata, keyed by alias. \"default\" is always the primary entry.",
+      "properties": {
+        "datasets": {
+          "additionalProperties": {
+            "properties": {
+              "id": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "id"
+            ],
+            "type": "object"
+          },
+          "description": "Map of dataset alias → metadata. Key \"default\" is always the run's primary dataset.",
+          "properties": {
+            "default": {
+              "properties": {
+                "apifyConsoleUrl": {
+                  "description": "Personalized Apify Console link to the dataset; present only for Console sessions",
+                  "type": "string"
+                },
+                "cleanItemCount": {
+                  "type": "number"
+                },
+                "fields": {
+                  "description": "Dataset field paths in dot notation (e.g. [\"metadata.url\"])",
+                  "items": {
+                    "type": "string"
+                  },
+                  "type": "array"
+                },
+                "id": {
+                  "description": "Dataset ID",
+                  "type": "string"
+                },
+                "inflatedBytes": {
+                  "description": "Approximate uncompressed byte size of the dataset. Use with itemCount to pick limit/fields before fetching.",
+                  "type": "number"
+                },
+                "itemCount": {
+                  "type": "number"
+                },
+                "name": {
+                  "type": "string"
+                },
+                "title": {
+                  "type": "string"
+                }
+              },
+              "required": [
+                "id"
+              ],
+              "type": "object"
+            }
+          },
+          "type": "object"
+        },
+        "keyValueStores": {
+          "additionalProperties": {
+            "properties": {
+              "id": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "id"
+            ],
+            "type": "object"
+          },
+          "description": "Map of key-value store alias → metadata. Key \"default\" is always the run's primary store.",
+          "properties": {
+            "default": {
+              "properties": {
+                "apifyConsoleUrl": {
+                  "description": "Personalized Apify Console link to the store; present only for Console sessions",
+                  "type": "string"
+                },
+                "id": {
+                  "description": "Key-value store ID",
+                  "type": "string"
+                },
+                "keyCount": {
+                  "description": "Total number of keys (omitted when truncated)",
+                  "type": "number"
+                },
+                "keys": {
+                  "description": "Up to 50 key names",
+                  "items": {
+                    "type": "string"
+                  },
+                  "type": "array"
+                },
+                "name": {
+                  "type": "string"
+                },
+                "title": {
+                  "type": "string"
+                }
+              },
+              "required": [
+                "id"
+              ],
+              "type": "object"
+            }
+          },
+          "type": "object"
+        }
+      },
+      "type": "object"
+    },
+    "summary": {
+      "description": "Past-tense summary of the run state",
+      "type": "string"
+    }
+  },
+  "required": [
+    "runId",
+    "actorId",
+    "status",
+    "storages",
+    "summary",
+    "nextStep"
+  ],
+  "type": "object"
+}
  6. First observedv0.10.13

TDQS

A4.2/5.0
Behavior4/5

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

With destructiveHint and idempotentHint annotations already declaring the destructive and idempotent nature, the description adds specific behavioral details: it aborts only starting/running runs, returns updated run details, and explains the graceful option with a 30-second timeout. This goes beyond the annotations without contradicting them, though it could mention edge cases like double-abort behavior.

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?

The description is well-structured: the main purpose is stated first, followed by behavioral details, then usage guidelines and examples. It is concise but includes an unnecessary repetition of 'Abort' in the USAGE line. The examples are helpful and the overall length is appropriate for the tool's complexity.

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?

Given the tool's simplicity (2 params, one required), the description is complete: it explains the core action, the conditions under which it has no effect, the return of updated run details, the graceful option, and provides concrete examples. The presence of an output schema means the description need not detail return fields. No critical information is missing.

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?

Both parameters (runId and gracefully) are fully described in the schema (100% coverage), and the description repeats the graceful behavior without adding new information beyond the schema. Since the schema already explains the parameters thoroughly, the description provides no extra value here, warranting the baseline score of 3.

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 clearly states the tool aborts an Actor run that is starting or running, and specifies that it has no effect on finished runs (SUCCEEDED, FAILED, ABORTING, ABORTED, TIMED-OUT). This precisely distinguishes it from sibling tools like get-actor-run (read-only) and call-actor (starts a run), leaving no ambiguity about the action and resource.

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?

The USAGE section explicitly says to use it when a run is 'taking too long or misconfigured,' and the no-effect statement implicitly warns against using it on already-finished runs. However, it does not explicitly name alternative tools (e.g., get-actor-run for checking status), so it falls short of the 'explicit alternatives' criterion for a 5.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/apify/apify-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server