Skip to content

Commit 2fcd4c0

Browse files
authored
feat: Update image in README and fix Actor README (#134)
1 parent 2de1fb6 commit 2fcd4c0

File tree

3 files changed

+11
-78
lines changed

3 files changed

+11
-78
lines changed

.actor/ACTOR.md

Lines changed: 11 additions & 75 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Apify Model Context Protocol (MCP) Server
22

3+
> **⚠️ Legacy solution notice**
4+
> 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.
5+
36
[![Actors MCP Server](https://apify.com/actor-badge?actor=apify/actors-mcp-server)](https://apify.com/apify/actors-mcp-server)
47

58
Implementation of an MCP server for all [Apify Actors](https://apify.com/store).
@@ -91,18 +94,13 @@ When a tool is called, the arguments are automatically passed to the Actor by th
9194
You can refer to the specific Actor's documentation for a list of available arguments.
9295

9396
### Helper tools
97+
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:
9498

95-
The server provides a set of helper tools to discover available Actors and retrieve their details:
96-
- `get-actor-details`: Retrieves documentation, input schema, and details about a specific Actor.
97-
- `discover-actors`: Searches for relevant Actors using keywords and returns their details.
98-
99-
There are also tools to manage the available tools list. However, dynamically adding and removing tools requires the MCP client to have the capability to update the tools list (handle `ToolListChangedNotificationSchema`), which is typically not supported.
100-
101-
You can try this functionality using the [Apify Tester MCP Client](https://apify.com/jiri.spilka/tester-mcp-client) Actor.
102-
To enable it, set the `enableActorAutoLoading` parameter.
103-
104-
- `add-actor-as-tool`: Adds an Actor by name to the available tools list without executing it, requiring user consent to run later.
105-
- `remove-actor-from-tool`: Removes an Actor by name from the available tools list when it's no longer needed.
99+
- Actor discovery and management: Search for Actors (`search-actors`), view details (`get-actor-details`), and dynamically add or remove tools (`add-actor`, `remove-actor`).
100+
- Actor execution and monitoring: Start Actor runs, fetch run results (`get-actor-run`), logs (`get-actor-log`), and abort runs (`abort-actor-run`).
101+
- Dataset access: List datasets, retrieve dataset info and items (`get-dataset`, `get-dataset-list`, `get-dataset-items`).
102+
- Key-value store access: List key-value stores, view keys, and retrieve records (`get-key-value-store-list`, `get-key-value-store`, `get-key-value-store-keys`, `get-key-value-store-record`).
103+
- Built-in help tool: A static helper (`apify-actor-help-tool`) that returns usage info for the Apify MCP Server.
106104

107105
## Prompt & Resources
108106

@@ -156,44 +154,6 @@ In the client settings, you need to provide server configuration:
156154
}
157155
}
158156
```
159-
Alternatively, you can use [clientSse.ts](https://github.com/apify/actor-mcp-server/tree/main/src/examples/clientSse.ts) script or test the server using `curl` </> commands.
160-
161-
1. Initiate Server-Sent-Events (SSE) by sending a GET request to the following URL:
162-
```
163-
curl https://actors-mcp-server.apify.actor/sse?token=<APIFY_TOKEN>
164-
```
165-
The server will respond with a `sessionId`, which you can use to send messages to the server:
166-
```shell
167-
event: endpoint
168-
data: /message?sessionId=a1b
169-
```
170-
171-
2. Send a message to the server by making a POST request with the `sessionId`:
172-
```shell
173-
curl -X POST "https://actors-mcp-server.apify.actor/message?token=<APIFY_TOKEN>&session_id=a1b" -H "Content-Type: application/json" -d '{
174-
"jsonrpc": "2.0",
175-
"id": 1,
176-
"method": "tools/call",
177-
"params": {
178-
"arguments": { "searchStringsArray": ["restaurants in San Francisco"], "maxCrawledPlacesPerSearch": 3 },
179-
"name": "lukaskrivka/google-maps-with-contact-details"
180-
}
181-
}'
182-
```
183-
The MCP server will start the Actor `lukaskrivka/google-maps-with-contact-details` with the provided arguments as input parameters.
184-
For this POST request, the server will respond with:
185-
186-
```text
187-
Accepted
188-
```
189-
190-
3. Receive the response. The server will invoke the specified Actor as a tool using the provided query parameters and stream the response back to the client via SSE.
191-
The response will be returned as JSON text.
192-
193-
```text
194-
event: message
195-
data: {"result":{"content":[{"type":"text","text":"{\"searchString\":\"restaurants in San Francisco\",\"rank\":1,\"title\":\"Gary Danko\",\"description\":\"Renowned chef Gary Danko's fixed-price menus of American cuisine ... \",\"price\":\"$100+\"...}}]}}
196-
```
197157

198158
## ⾕ MCP Server at a local host
199159

@@ -216,7 +176,7 @@ If not, follow this guide to install Node.js: [Downloading and installing Node.j
216176

217177
#### Claude Desktop
218178

219-
To configure Claude Desktop to work with the MCP server, follow these steps. For a detailed guide, refer to the [Claude Desktop Users Guide](https://modelcontextprotocol.io/quickstart/user).
179+
To configure Claude Desktop to work with the MCP server, follow these steps. For a detailed guide, refer to the [Claude Desktop Users Guide](https://modelcontextprotocol.io/quickstart/user) or watch the [video tutorial](https://youtu.be/gf5WXeqydUU?t=440).
220180

221181
1. Download Claude for desktop
222182
- Available for Windows and macOS.
@@ -401,31 +361,6 @@ export APIFY_TOKEN=your-apify-token
401361
npx @modelcontextprotocol/inspector npx -y @apify/actors-mcp-server
402362
```
403363

404-
### Installing via Smithery
405-
406-
To install Apify Actors MCP Server for Claude Desktop automatically via [Smithery](https://smithery.ai/server/@apify/actors-mcp-server):
407-
408-
```bash
409-
npx -y @smithery/cli install @apify/actors-mcp-server --client claude
410-
```
411-
412-
#### Stdio clients
413-
414-
Create an environment file `.env` with the following content:
415-
```text
416-
APIFY_TOKEN=your-apify-token
417-
```
418-
In the `examples` directory, you can find an example client to interact with the server via
419-
standard input/output (stdio):
420-
421-
- [`clientStdio.ts`](https://github.com/apify/actor-mcp-server/tree/main/src/examples/clientStdio.ts)
422-
This client script starts the MCP server with two specified Actors.
423-
It then calls the `apify/rag-web-browser` tool with a query and prints the result.
424-
It demonstrates how to connect to the MCP server, list available tools, and call a specific tool using stdio transport.
425-
```bash
426-
node dist/examples/clientStdio.js
427-
```
428-
429364
# 👷🏼 Development
430365

431366
## Prerequisites
@@ -499,6 +434,7 @@ If you need other features or have any feedback, [submit an issue](https://conso
499434
- [Model Context Protocol](https://modelcontextprotocol.org/)
500435
- [What are AI Agents?](https://blog.apify.com/what-are-ai-agents/)
501436
- [What is MCP and why does it matter?](https://blog.apify.com/what-is-model-context-protocol/)
437+
- [How to use MCP with Apify Actors](https://blog.apify.com/how-to-use-mcp/)
502438
- [Tester MCP Client](https://apify.com/jiri.spilka/tester-mcp-client)
503439
- [AI agent workflow: building an agent to query Apify datasets](https://blog.apify.com/ai-agent-workflow/)
504440
- [MCP Client development guide](https://github.com/cyanheads/model-context-protocol-resources/blob/main/guides/mcp-client-development-guide.md)

README.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
11
# Apify Model Context Protocol (MCP) Server
22

3-
> **⚠️ Legacy solution notice**
4-
> 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.
5-
63
[![Actors MCP Server](https://apify.com/actor-badge?actor=apify/actors-mcp-server)](https://apify.com/apify/actors-mcp-server)
74

85
Implementation of an MCP server for all [Apify Actors](https://apify.com/store).

docs/actors-mcp-server.png

-139 KB
Loading

0 commit comments

Comments
 (0)