You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
.describe('The name of the Actor to call. For example, "apify/rag-web-browser".'),
303
303
step: z.enum(['info','call'])
304
304
.default('info')
305
-
.describe(`Step to perform: "info" to get Actor details and input schema (required first step), "call" to execute the Actor (only after getting info).`),
305
+
.describe(`Step to perform: "info" to get Actor details and input schema (required first step), "call" to run the Actor (only after getting info).`),
306
306
input: z.object({}).passthrough()
307
307
.optional()
308
308
.describe(`The input JSON to pass to the Actor. For example, {"query": "apify", "maxResults": 5, "outputFormats": ["markdown"]}. Required only when step is "call".`),
description: `Call any Actor from Apify Store - two-step process
329
-
This tool uses a mandatory two-step process to safely call any Actor from the Apify store.
328
+
description: `Call any Actor from the Apify Store using a mandatory two-step workflow.
329
+
This ensures you first get the Actor’s input schema and details before executing it safely.
330
330
331
-
USAGE:
332
-
• ONLY for Actors that are NOT available as dedicated tools
333
-
• If a dedicated tool exists (e.g., ${actorNameToToolName('apify/rag-web-browser')}), use that instead
331
+
There are two ways to run Actors:
332
+
1. Dedicated Actor tools (e.g., ${actorNameToToolName('apify/rag-web-browser')}): These are pre-configured tools, offering a simpler and more direct experience.
333
+
2. Generic call-actor tool (${HelperTools.ACTOR_CALL}): Use this when a dedicated tool is not available or when you want to run any Actor dynamically. This tool is especially useful if you do not want to add specific tools or your client does not support dynamic tool registration.
334
+
335
+
**Important:**
334
336
335
-
MANDATORY TWO-STEP WORKFLOW:
337
+
A successful run returns a \`datasetId\` (the Actor's output stored as an Apify dataset) and a short preview of items.
338
+
To fetch the full output, use the ${HelperTools.ACTOR_OUTPUT_GET} tool with the \`datasetId\`.
339
+
340
+
USAGE:
341
+
- Always use dedicated tools when available (e.g., ${actorNameToToolName('apify/rag-web-browser')})
342
+
- Use the generic call-actor tool only if a dedicated tool does not exist for your Actor.
336
343
344
+
MANDATORY TWO-STEP-WORKFLOW:
337
345
Step 1: Get Actor Info (step="info", default)
338
346
- First call this tool with step="info" to get Actor details and input schema
339
347
- This returns the Actor description, documentation, and required input schema
@@ -344,7 +352,8 @@ Step 2: Call Actor (step="call")
344
352
- This calls and runs the Actor. It will create an output as an Apify dataset (with datasetId).
345
353
- This step returns a dataset preview, typically JSON-formatted tabular data.
346
354
347
-
The step parameter enforces this workflow - you cannot call an Actor without first getting its info.`,
355
+
EXAMPLES:
356
+
- user_input: Get instagram posts using apify/instagram-scraper`,
description: `Fetch the dataset of a specific Actor run based on datasetId.
72
-
You can also retrieve only specific fields from the output if needed.
71
+
description: `Retrieve the output dataset items of a specific Actor run using its datasetId.
72
+
You can select specific fields to return (supports dot notation like "crawl.statusCode") and paginate results with offset and limit.
73
+
This tool is a simplified version of the get-dataset-items tool, focused on Actor run outputs.
74
+
75
+
The results will include the dataset items from the specified dataset. If you provide fields, only those fields will be included (nested fields supported via dot notation).
76
+
77
+
You can obtain the datasetId from an Actor run (e.g., after calling an Actor with the call-actor tool) or from the Apify Console (Runs → Run details → Dataset ID).
73
78
74
79
USAGE:
75
-
- Use this tool to get Actor dataset outside of the preview, or to access fields from the Actor output
76
-
dataset schema that are not included in the preview.
80
+
- Use when you need to read Actor output data (full items or selected fields), especially when preview does not include all fields.
77
81
78
82
EXAMPLES:
79
-
- user_input: Get data of my last Actor run?
80
-
- user_input: Get number_of_likes from my dataset?
83
+
- user_input: Get data of my last Actor run
84
+
- user_input: Get number_of_likes from my dataset
85
+
- user_input: Return only crawl.statusCode and url from dataset 8TtYhCwKzQeQk7dJx
81
86
82
-
Note: This tool is automatically included if the Apify MCP Server is configured with any Actor tools
83
-
(e.g. "apify-slash-rag-web-browser") or tools that can interact with Actors (e.g. "call-actor", "add-actor").`,
87
+
Note: This tool is automatically included if the Apify MCP Server is configured with any Actor tools (e.g., "apify-slash-rag-web-browser") or tools that can interact with Actors (e.g., "call-actor", "add-actor").`,
84
88
inputSchema: zodToJsonSchema(getActorOutputArgs),
85
89
/**
86
90
* Allow additional properties for Skyfire mode to pass `skyfire-pay-id`.
description: `Retrieves the HTML skeleton (clean structure) from a given URL by stripping unwanted elements like scripts, styles, and non-essential attributes. This tool keeps only the core HTML structure, links, images, and data attributes for analysis. Supports optional JavaScript rendering for dynamic content and provides chunked output to handle large HTML. This tool is useful for building web scrapers and data extraction tasks where a clean HTML structure is needed for writing concrete selectors or parsers.`,
44
+
description: `Retrieve the HTML skeleton (clean structure) of a webpage by stripping scripts, styles, and non-essential attributes.
45
+
This keeps the core HTML structure, links, images, and data attributes for analysis. Supports optional JavaScript rendering for dynamic pages.
46
+
47
+
The results will include a chunked HTML skeleton if the content is large. Use the chunk parameter to paginate through the output.
48
+
49
+
USAGE:
50
+
- Use when you need a clean HTML structure to design selectors or parsers for scraping.
51
+
52
+
EXAMPLES:
53
+
- user_input: Get HTML skeleton for https://example.com
54
+
- user_input: Get next chunk of HTML skeleton for https://example.com (chunk=2)`,
0 commit comments