Skip to content

Commit d681068

Browse files
vystrcildTC-MO
andauthored
docs: Oauth + adding multiple Actors for Streamable/SSE (#1660)
Co-authored-by: Michał Olender <[email protected]>
1 parent 84e100e commit d681068

File tree

1 file changed

+33
-4
lines changed
  • sources/platform/integrations/ai

1 file changed

+33
-4
lines changed

sources/platform/integrations/ai/mcp.md

Lines changed: 33 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ The _Apify Model Context Protocol (MCP) Server_ allows AI applications to connec
1616

1717
You can use the Apify MCP Server in two ways:
1818

19+
- _HTTPS Endpoint_ `mcp.apify.com`: Connect your MCP client through OAuth or by including `Authorization: Bearer <APIFY_TOKEN>` header in your requests.
20+
- `https://mcp.apify.com` for streamable transport
21+
- `https://mcp.apify.com/sse` for legacy SSE transport
1922
- _Standard Input/Output (stdio)_: Ideal for local integrations and command-line tools such as the Claude for Desktop client.
2023
- Set MCP client server command to `npx @apify/actors-mcp-server` and environment variable `APIFY_TOKEN` to your Apify API token
2124
- See `npx @apify/actors-mcp-server --help` for more options
22-
- _HTTPS Endpoint_ `mcp.apify.com`: Connect your MCP client by including `Authorization: Bearer <APIFY_TOKEN>` header in your requests.
23-
- `https://mcp.apify.com` for streamable transport
24-
- `https://mcp.apify.com/sse` for legacy SSE transport
2525

2626
You could also use legacy option by running [Apify Actors MCP Server](https://apify.com/apify/actors-mcp-server) as an Actor.
2727

@@ -34,6 +34,22 @@ Before you start, make sure you have the following:
3434
1. _Apify API Token:_ Get your personal API token from the **Integrations** section in [Apify Console](https://console.apify.com/account#/integrations). This token will be used to authorize the MCP server to run Actors on your behalf.
3535
1. _MCP client:_ An AI agent or client that supports MCP. This could be Anthropic Claude for Desktop, a VS Code extension with MCP support, Apify’s web-based Tester MCP Client, or any custom client implementation. See supported MCP clients in [official documentation](https://modelcontextprotocol.io/clients).
3636

37+
## Example usage (Streamable HTTP with OAuth)
38+
39+
We recommend connecting through OAuth for a secure and simple authentication process.
40+
41+
During setup, provide the server URL `https://mcp.apify.com`. You will then be redirected to your browser to sign in to your Apify account and approve the connection. The configuration steps may vary slightly depending on your MCP client.
42+
43+
```json
44+
{
45+
"mcpServers": {
46+
"apify": {
47+
"url": "https://mcp.apify.com"
48+
}
49+
}
50+
}
51+
```
52+
3753
## Example usage (local stdio with Claude for Desktop)
3854

3955
Let’s walk through an example of using Claude for Desktop with the Apify MCP Server:
@@ -96,7 +112,19 @@ By default, the main Actors MCP Server starts with a single default [RAG Web Bro
96112
_Tools for adding and removing Actors are enabled by default._
97113
You can disable these tools by setting the parameter `?enableAddingActors=false` in the MCP Server URL, or with the CLI flag `--enable-adding-actors=false` (can also be set in Claude for Desktop config args as `--enable-adding-actors=false`).
98114
Not all MCP client frameworks allow dynamic tool addition at runtime, but Apify’s own tester client does, if adding Actors is enabled.
99-
- _Via config file:_ When using Claude for Desktop, you can specify which Actors should be immediately available by configuring your `mcpServers` settings. Add the Actors as a comma-separated list in the `--actors` parameter, as shown in the example below. This pre-loads your selected tools without requiring discovery during conversations, ideal for workflows with predictable tool needs.
115+
- _Via url:_ If you are using Streamable HTTP or SSE protocol, you could add `actors` query parameter with Actor names separated by comma:
116+
117+
```json
118+
{
119+
"mcpServers": {
120+
"Apify": {
121+
"url": "https://mcp.apify.com/?actors=lukaskrivka/google-maps-with-contact-details,apify/instagram-scraper"
122+
}
123+
}
124+
}
125+
```
126+
127+
- _Via config file:_ For local stdio connection, you can specify which Actors should be immediately available by configuring your json configuration. Add the Actors as a comma-separated list in the `--actors` parameter, as shown in the example below. This pre-loads your selected tools without requiring discovery during conversations, ideal for workflows with predictable tool needs.
100128

101129
```json
102130
{
@@ -115,6 +143,7 @@ By default, the main Actors MCP Server starts with a single default [RAG Web Bro
115143
}
116144
```
117145

146+
118147
In summary, you can start with a broad set (everything open and discoverable) or a narrow set (just what you need) and even expand tools on the fly, giving your agent a lot of flexibility without overwhelming it initially.
119148

120149
## Dynamic Actor tooling

0 commit comments

Comments
 (0)