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
> This Actor is legacy implementation of the Apify MCP Server. For the current and actively maintained solution, please visit **[mcp.apify.com](https://mcp.apify.com)** where you'll find the latest server, comprehensive documentation, and setup guides.
3
+
> **💾 Legacy**
4
+
> This Actor is a legacy implementation of the Apify MCP Server. For the current and actively maintained solution, please visit **[mcp.apify.com](https://mcp.apify.com)** where you'll find the latest server, comprehensive documentation, and setup guides.
Implementation of an MCP server for all [Apify Actors](https://apify.com/store).
9
9
This server enables interaction with one or more Apify Actors that can be defined in the MCP Server configuration.
10
10
11
11
The server can be used in two ways:
12
-
-**🇦 [MCP Server Actor](https://apify.com/apify/actors-mcp-server)** – HTTP server accessible via Server-Sent Events (SSE), see [guide](#-mcp-server-actor)
12
+
-**🇦 [MCP Server Actor](https://apify.com/apify/actors-mcp-server)** – HTTP server accessible via http-streamable transport, see [guide](#-remote-mcp-server)
13
13
-**⾕ MCP Server Stdio** – Local server available via standard input/output (stdio), see [guide](#-mcp-server-at-a-local-host)
14
14
15
15
You can also interact with the MCP server using a chat-like UI with 💬 [Tester MCP Client](https://apify.com/jiri.spilka/tester-mcp-client)
@@ -24,13 +24,17 @@ For example, it can:
24
24
- Use [Instagram Scraper](https://apify.com/apify/instagram-scraper) to scrape Instagram posts, profiles, places, photos, and comments
25
25
- Use [RAG Web Browser](https://apify.com/apify/web-scraper) to search the web, scrape the top N URLs, and return their content
26
26
27
+
Learn about the key features and capabilities in the **Apify MCP Server Tutorial: Integrate 5,000+ Apify Actors and Agents Into Claude** video
28
+
29
+
[Apify MCP Server Tutorial: Integrate 5,000+ Apify Actors and Agents Into Claude](https://www.youtube.com/watch?v=BKu8H91uCTg)
30
+
27
31
# MCP Clients
28
32
29
33
To interact with the Apify MCP server, you can use MCP clients such as:
With the MCP Tester client you can load Actors dynamically but this is not yet supported by other MCP clients.
49
-
We also plan to add more features, see [Roadmap](#-roadmap-march-2025) for more details.
52
+
With the MCP Tester client you can load Actors dynamically but this might not be supported by other MCP clients.
50
53
51
54
# 🔄 What is the Model Context Protocol?
52
55
@@ -68,32 +71,24 @@ Interested in building and monetizing your own AI agent on Apify? Check out our
68
71
69
72
### Actors
70
73
Any [Apify Actor](https://apify.com/store) can be used as a tool.
71
-
By default, the server is pre-configured with the Actors specified below, but this can be overridden by providing the `?actors` URL query parameter.
72
-
73
-
```text
74
-
'apify/rag-web-browser'
75
-
```
76
-
For example, to additionally load the `apify/instagram-scraper` Actor, you can start the server with the following URL:
74
+
By default, the server is pre-configured with the `apify/rag-web-browser` Actor, but this can be overridden by providing the `actors` URL query parameter.
75
+
For example, to load both `apify/rag-web-browser` and `apify/instagram-scraper`, start the server with the following URL:
The MCP server loads the Actor input schema and creates MCP tools corresponding to the Actors.
82
-
See this example of input schema for the [RAG Web Browser](https://apify.com/apify/rag-web-browser/input-schema).
80
+
The MCP server automatically loads the input schema for each Actor to create corresponding MCP tools.
81
+
See this example of an input schema for the [RAG Web Browser](https://apify.com/apify/rag-web-browser/input-schema).
83
82
84
-
The tool name must always be the full Actor name, such as `apify/rag-web-browser`.
85
-
The arguments for an MCP tool represent the input parameters of the Actor.
86
-
For example, for the `apify/rag-web-browser` Actor, the arguments are:
83
+
The tool name is always the full Actor name (e.g., `apify/rag-web-browser`), and its arguments correspond to the Actor's input parameters. For instance:
87
84
88
85
```json
89
86
{
90
87
"query": "restaurants in San Francisco",
91
88
"maxResults": 3
92
89
}
93
90
```
94
-
You don't need to specify the input parameters or which Actor to call; everything is managed by an LLM.
95
-
When a tool is called, the arguments are automatically passed to the Actor by the LLM.
96
-
You can refer to the specific Actor's documentation for a list of available arguments.
91
+
You don't need to specify which Actor to call or what its input parameters are; the LLM handles this automatically. To understand an Actor's full capabilities, you can find the complete list of arguments in its documentation.
97
92
98
93
### Helper tools
99
94
One of the powerful features of MCP with Apify is dynamic actor tooling – the ability for an AI agent to find new tools (Actors) as needed and incorporate them. Here are some special MCP operations and how Apify MCP Server supports them:
@@ -114,43 +109,41 @@ We plan to add [Apify's dataset](https://docs.apify.com/platform/storage/dataset
114
109
The Apify MCP Server can be used in two ways: **as an Apify Actor** running on the Apify platform
115
110
or as a **local server** running on your machine.
116
111
117
-
## 🇦 MCP Server Actor
112
+
## 🇦 Remote MCP Server
118
113
119
-
### Standby web server
114
+
The MCP server is an Apify Actor that runs in [**Standby mode**](https://docs.apify.com/platform/actors/running/standby) with an HTTP web server that receives and processes requests.
120
115
121
-
The Actor runs in [**Standby mode**](https://docs.apify.com/platform/actors/running/standby) with an HTTP web server that receives and processes requests.
122
-
123
-
To start the server with default Actors, send an HTTP GET request with your [Apify API token](https://console.apify.com/settings/integrations) to the following URL:
116
+
To use the server with default set of Actors, add your [Apify API token](https://console.apify.com/settings/integrations) to the following URL:
You can find a list of all available Actors in the [Apify Store](https://apify.com/store).
136
129
137
-
#### 💬 Interact with the MCP Server over SSE
130
+
#### 💬 Interact with the MCP Server over HTTP-Streamable transport
138
131
139
-
Once the server is running, you can interact with Server-Sent Events (SSE) to send messages to the server and receive responses.
132
+
Once the server is running, you can interact with it using http-streamable transport.
140
133
The easiest way is to use [Tester MCP Client](https://apify.com/jiri.spilka/tester-mcp-client) on Apify.
141
134
142
-
[Claude Desktop](https://claude.ai/download)currently lacks SSE support, but you can use it with Stdio transport; see [MCP Server at a local host](#-mcp-server-at-a-local-host) for more details.
135
+
[Claude Desktop](https://claude.ai/download)does not support remote MCP servers. To use it, you must run the server locally. See the [local host guide](#-mcp-server-at-a-local-host) for setup instructions.
143
136
Note: The free version of Claude Desktop may experience intermittent connection issues with the server.
144
137
145
138
In the client settings, you need to provide server configuration:
@@ -160,7 +153,6 @@ In the client settings, you need to provide server configuration:
160
153
## ⾕ MCP Server at a local host
161
154
162
155
You can run the Apify MCP Server on your local machine by configuring it with Claude Desktop or any other [MCP client](https://modelcontextprotocol.io/clients).
163
-
You can also use [Smithery](https://smithery.ai/server/@apify/actors-mcp-server) to install the server automatically.
164
156
165
157
### Prerequisites
166
158
@@ -248,8 +240,6 @@ For one-click installation, click one of the install buttons below:
248
240
249
241
##### Manual installation
250
242
251
-
You can manually install the Apify MCP Server in VS Code. First, click one of the install buttons at the top of this section for a one-click installation.
252
-
253
243
Alternatively, add the following JSON block to your User Settings (JSON) file in VS Code. You can do this by pressing `Ctrl + Shift + P` and typing `Preferences: Open User Settings (JSON)`.
254
244
255
245
```json
@@ -297,64 +287,7 @@ If you want to specify which Actors to load, you can add the `--actors` argument
297
287
}
298
288
```
299
289
300
-
#### VS Code
301
-
302
-
For one-click installation, click one of the install buttons below:
303
-
304
-
[](https://insiders.vscode.dev/redirect/mcp/install?name=actors-mcp-server&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40apify%2Factors-mcp-server%22%5D%2C%22env%22%3A%7B%22APIFY_TOKEN%22%3A%22%24%7Binput%3Aapify_token%7D%22%7D%7D&inputs=%5B%7B%22type%22%3A%22promptString%22%2C%22id%22%3A%22apify_token%22%2C%22description%22%3A%22Apify+API+Token%22%2C%22password%22%3Atrue%7D%5D) [](https://insiders.vscode.dev/redirect/mcp/install?name=actors-mcp-server&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40apify%2Factors-mcp-server%22%5D%2C%22env%22%3A%7B%22APIFY_TOKEN%22%3A%22%24%7Binput%3Aapify_token%7D%22%7D%7D&inputs=%5B%7B%22type%22%3A%22promptString%22%2C%22id%22%3A%22apify_token%22%2C%22description%22%3A%22Apify+API+Token%22%2C%22password%22%3Atrue%7D%5D&quality=insiders)
305
-
306
-
##### Manual installation
307
-
308
-
You can manually install the Apify MCP Server in VS Code. First, click one of the install buttons at the top of this section for a one-click installation.
309
-
310
-
Alternatively, add the following JSON block to your User Settings (JSON) file in VS Code. You can do this by pressing `Ctrl + Shift + P` and typing `Preferences: Open User Settings (JSON)`.
311
-
312
-
```json
313
-
{
314
-
"mcp": {
315
-
"inputs": [
316
-
{
317
-
"type": "promptString",
318
-
"id": "apify_token",
319
-
"description": "Apify API Token",
320
-
"password": true
321
-
}
322
-
],
323
-
"servers": {
324
-
"actors-mcp-server": {
325
-
"command": "npx",
326
-
"args": ["-y", "@apify/actors-mcp-server"],
327
-
"env": {
328
-
"APIFY_TOKEN": "${input:apify_token}"
329
-
}
330
-
}
331
-
}
332
-
}
333
-
}
334
-
```
335
-
336
-
Optionally, you can add it to a file called `.vscode/mcp.json` in your workspace - just omit the top-level `mcp {}` key. This will allow you to share the configuration with others.
337
-
338
-
If you want to specify which Actors to load, you can add the `--actors` argument:
#### Debugging NPM package @apify/actors-mcp-server with @modelcontextprotocol/inspector
290
+
#### Debugging the installed NPM package
358
291
359
292
To debug the server, use the [MCP Inspector](https://github.com/modelcontextprotocol/inspector) tool:
360
293
@@ -381,17 +314,7 @@ Build the actor-mcp-server package:
381
314
npm run build
382
315
```
383
316
384
-
## Local client (SSE)
385
-
386
-
To test the server with the SSE transport, you can use the script `examples/clientSse.ts`:
387
-
Currently, the Node.js client does not support establishing a connection to a remote server with custom headers.
388
-
You need to change the URL to your local server URL in the script.
389
-
390
-
```bash
391
-
node dist/examples/clientSse.js
392
-
```
393
-
394
-
## Debugging
317
+
## Debugging from source
395
318
396
319
Since MCP servers operate over standard input/output (stdio), debugging can be challenging.
397
320
For the best debugging experience, use the [MCP Inspector](https://github.com/modelcontextprotocol/inspector).
@@ -407,7 +330,7 @@ Upon launching, the Inspector will display a URL that you can access in your bro
407
330
408
331
## ⓘ Limitations and feedback
409
332
410
-
The Actor input schema is processed to be compatible with most MCP clients while adhering to [JSON Schema](https://json-schema.org/) standards. The processing includes:
333
+
To ensure compatibility with various MCP clients, the Actor input schema is automatically processed while adhering to [JSON Schema](https://json-schema.org/) standards. Key adjustments include:
411
334
-**Descriptions** are truncated to 500 characters (as defined in `MAX_DESCRIPTION_LENGTH`).
412
335
-**Enum fields** are truncated to a maximum combined length of 200 characters for all elements (as defined in `ACTOR_ENUM_MAX_LENGTH`).
413
336
-**Required fields** are explicitly marked with a "REQUIRED" prefix in their descriptions for compatibility with frameworks that may not handle JSON schema properly.
@@ -420,11 +343,6 @@ Free users have an 8GB limit, 128MB needs to be allocated for running `Actors-MC
420
343
421
344
If you need other features or have any feedback, [submit an issue](https://console.apify.com/actors/1lSvMAaRcadrM1Vgv/issues) in Apify Console to let us know.
422
345
423
-
# 🚀 Roadmap (March 2025)
424
-
425
-
- Add Apify's dataset and key-value store as resources.
426
-
- Add tools such as Actor logs and Actor runs for debugging.
427
-
428
346
# 🐛 Troubleshooting
429
347
430
348
- Make sure you have the `node` installed by running `node -v`
@@ -438,6 +356,5 @@ If you need other features or have any feedback, [submit an issue](https://conso
438
356
-[What is MCP and why does it matter?](https://blog.apify.com/what-is-model-context-protocol/)
439
357
-[How to use MCP with Apify Actors](https://blog.apify.com/how-to-use-mcp/)
0 commit comments