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
- Add resource list method to prevent client not respecting capabilities from crashing, update manifest.json for dxt ([#249](https://github.com/apify/apify-mcp-server/pull/249)) ([1dca956](https://github.com/apify/apify-mcp-server/commit/1dca956e5deb3efbb604005710fdbf2794202321)) by [@MQ37](https://github.com/MQ37)
-**input:** Allow empty tools and actors to allow greater control of exposed tools ([#218](https://github.com/apify/apify-mcp-server/pull/218)) ([a4a8638](https://github.com/apify/apify-mcp-server/commit/a4a86389fb65bed099974993ab34b63f7159064d)) by [@MQ37](https://github.com/MQ37), closes [#214](https://github.com/apify/apify-mcp-server/issues/214)
37
+
38
+
### 🐛 Bug Fixes
39
+
40
+
- Description in package.json and manifest.json ([#234](https://github.com/apify/apify-mcp-server/pull/234)) ([9f4bcfa](https://github.com/apify/apify-mcp-server/commit/9f4bcfa59df231d12efe1ca574641943c1d1e26e)) by [@jirispilka](https://github.com/jirispilka)
41
+
- Change github repository links ([#237](https://github.com/apify/apify-mcp-server/pull/237)) ([6216fa4](https://github.com/apify/apify-mcp-server/commit/6216fa40638616c481ce401cd671a112e897e42a)) by [@jirispilka](https://github.com/jirispilka)
Copy file name to clipboardExpand all lines: README.md
+89-22Lines changed: 89 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ The Apify Model Context Protocol (MCP) Server at **mcp.apify.com** instantly con
26
26
>
27
27
> It supports OAuth, so you can connect from clients like Claude.ai or Visual Studio Code with just the URL.
28
28
29
-

29
+

30
30
31
31
## Table of Contents
32
32
-[🌐 Introducing the Apify MCP server](#-introducing-the-apify-mcp-server)
@@ -107,7 +107,7 @@ Check out [Apify Tester MCP Client](https://apify.com/jiri.spilka/tester-mcp-cli
107
107
This interactive, chat-like interface provides an easy way to explore the capabilities of Apify MCP without any local setup.
108
108
Just sign in with your Apify account and start experimenting with web scraping, data extraction, and automation tools!
109
109
110
-
Or use the Anthropic Desktop extension file (dxt) for one-click installation: [Apify MCP server dxt file](https://github.com/apify/actors-mcp-server/releases/latest/download/actors-mcp-server.dxt)
110
+
Or use the Anthropic Desktop extension file (dxt) for one-click installation: [Apify MCP server dxt file](https://github.com/apify/apify-mcp-server/releases/latest/download/apify-mcp-server.dxt)
111
111
112
112
# 🛠️ Tools, resources, and prompts
113
113
@@ -140,43 +140,107 @@ One of the most powerful features of using MCP with Apify is dynamic tool discov
140
140
It gives an AI agent the ability to find new tools (Actors) as needed and incorporate them.
141
141
Here are some special MCP operations and how the Apify MCP Server supports them:
142
142
143
-
-**Actor discovery and management**: Search for Actors, view their details, and dynamically add or remove them as available tools for the AI.
143
+
-**Apify Actors**: Search for Actors, view their details, and use them as tools for the AI.
144
144
-**Apify documentation**: Search the Apify documentation and fetch specific documents to provide context to the AI.
145
-
-**Actor runs (*)**: Get lists of your Actor runs, inspect their details, and retrieve logs.
146
-
-**Apify storage (*)**: Access data from your datasets and key-value stores.
147
-
148
-
**Note**: Helper tool categories marked with (*) are not enabled by default in the MCP server and must be explicitly enabled using the `tools` argument (either the `--tools` command line argument for the stdio server or the `?tools` URL query parameter for the remote MCP server). The `tools` argument is a comma-separated list of categories with the following possible values:
149
-
150
-
-`docs`: Search and fetch Apify documentation tools.
151
-
-`runs`: Get Actor run lists, run details, and logs from a specific Actor run.
152
-
-`storage`: Access datasets, key-value stores, and their records.
153
-
-`preview`: Experimental tools in preview mode.
154
-
155
-
For example, to enable all tools, use `npx @apify/actors-mcp-server --tools docs,runs,storage,preview` or `https://mcp.apify.com/?tools=docs,runs,storage,preview`.
145
+
-**Actor runs**: Get lists of your Actor runs, inspect their details, and retrieve logs.
146
+
-**Apify storage**: Access data from your datasets and key-value stores.
156
147
157
148
### Overview of available tools
158
149
159
150
Here is an overview list of all the tools provided by the Apify MCP Server.
160
151
161
152
| Tool name | Category | Description | Enabled by default |
162
153
| :--- | :--- | :--- | :---: |
163
-
|`get-actor-details`|default|Retrieve detailed information about a specific Actor. | ✅ |
164
-
|`search-actors`|default|Search for Actors in the Apify Store. | ✅ |
165
-
|`add-actor`|default|Add an Actor as a new tool for the user to call. | ✅ |
166
-
|[`apify-slash-rag-web-browser`](https://apify.com/apify/rag-web-browser)|default| An Actor tool to browse the web. | ✅ |
154
+
|`search-actors`|actors|Search for Actors in the Apify Store. | ✅ |
155
+
|`fetch-actor-details`|actors|Retrieve detailed information about a specific Actor. | ✅ |
156
+
|`call-actor`|actors|Call an Actor and get its run results. | ✅ |
157
+
|[`apify-slash-rag-web-browser`](https://apify.com/apify/rag-web-browser)|Actor (see [tool configuration](#tools-configuration))| An Actor tool to browse the web. | ✅ |
167
158
|`search-apify-docs`| docs | Search the Apify documentation for relevant pages. | ✅ |
168
159
|`fetch-apify-docs`| docs | Fetch the full content of an Apify documentation page by its URL. | ✅ |
169
-
|`call-actor`| preview | Call an Actor and get its run results. ||
170
160
|`get-actor-run`| runs | Get detailed information about a specific Actor run. ||
171
161
|`get-actor-run-list`| runs | Get a list of an Actor's runs, filterable by status. ||
172
162
|`get-actor-log`| runs | Retrieve the logs for a specific Actor run. ||
173
163
|`get-dataset`| storage | Get metadata about a specific dataset. ||
174
164
|`get-dataset-items`| storage | Retrieve items from a dataset with support for filtering and pagination. ||
165
+
|`get-dataset-schema`| storage | Generate a JSON schema from dataset items. ||
175
166
|`get-key-value-store`| storage | Get metadata about a specific key-value store. ||
176
167
|`get-key-value-store-keys`| storage | List the keys within a specific key-value store. ||
177
168
|`get-key-value-store-record`| storage | Get the value associated with a specific key in a key-value store. ||
178
169
|`get-dataset-list`| storage | List all available datasets for the user. ||
179
170
|`get-key-value-store-list`| storage | List all available key-value stores for the user. ||
171
+
|`add-actor`| experimental | Add an Actor as a new tool for the user to call. ||
172
+
173
+
### Tools configuration
174
+
175
+
The `tools` configuration parameter is used to specify loaded tools - either categories or specific tools directly, and Apify Actors. For example, `tools=storage,runs` loads two categories; `tools=add-actor` loads just one tool.
176
+
177
+
When no query parameters are provided, the MCP server loads the following `tools` by default:
178
+
179
+
-`actors`
180
+
-`docs`
181
+
-`apify/rag-web-browser`
182
+
183
+
If the tools parameter is specified, only the listed tools or categories will be enabled - no default tools will be included.
184
+
185
+
> **Easy configuration:**
186
+
>
187
+
> Use the [UI configurator](https://mcp.apify.com/) to configure your server, then copy the configuration to your client.
188
+
189
+
**Configuring the hosted server:**
190
+
191
+
The hosted server can be configured using query parameters in the URL. For example, to load the default tools, use:
For minimal configuration, if you want to use only a single Actor tool - without any discovery or generic calling tools, the server can be configured as follows:
198
+
199
+
```
200
+
https://mcp.apify.com?tools=apify/my-actor
201
+
```
202
+
203
+
This setup exposes only the specified Actor (`apify/my-actor`) as a tool. No other tools will be available.
204
+
205
+
**Configuring the CLI:**
206
+
207
+
The CLI can be configured using command-line flags. For example, to load the same tools as in the hosted server configuration, use:
As above, this exposes only the specified Actor (`apify/my-actor`) as a tool. No other tools will be available.
220
+
221
+
> **⚠️ Important recommendation**
222
+
>
223
+
> **The default tools configuration may change in future versions.** When no `tools` parameter is specified, the server currently loads default tools, but this behavior is subject to change.
224
+
>
225
+
> **For production use and stable interfaces, always explicitly specify the `tools` parameter** to ensure your configuration remains consistent across updates.
226
+
227
+
### Backward compatibility
228
+
229
+
The v2 configuration preserves backward compatibility with v1 usage. Notes:
230
+
231
+
-`actors` param (URL) and `--actors` flag (CLI) are still supported.
232
+
- Internally they are merged into `tools` selectors.
-`enable-adding-actors` (CLI) and `enableAddingActors` (URL) are supported but deprecated.
235
+
- Prefer `tools=experimental` or including the specific tool `tools=add-actor`.
236
+
- Behavior remains: when enabled with no `tools` specified, the server exposes only `add-actor`; when categories/tools are selected, `add-actor` is also included.
237
+
-`enableActorAutoLoading` remains as a legacy alias for `enableAddingActors` and is mapped automatically.
238
+
- Defaults remain compatible: when no `tools` are specified, the server loads `actors`, `docs`, and `apify/rag-web-browser`.
239
+
- If any `tools` are specified, the defaults are not added (same as v1 intent for explicit selection).
240
+
-`call-actor` is now included by default via the `actors` category (additive change). To exclude it, specify an explicit `tools` list without `actors`.
241
+
-`preview` category is deprecated and removed. Use specific tool names instead.
242
+
243
+
Existing URLs and commands using `?actors=...` or `--actors` continue to work unchanged.
180
244
181
245
### Prompts
182
246
@@ -237,9 +301,12 @@ Upon launching, the Inspector will display a URL that you can open in your brows
237
301
238
302
## 🐦 Canary PR releases
239
303
240
-
Due to the current architecture where Apify MCP is split across two repositories, this one containing the core MCP logic and the private [apify-mcp-server](https://github.com/apify/apify-mcp-server) repository that handles the actual server implementation for [mcp.apify.com](https://mcp.apify.com), development can be challenging as changes need to be synchronized between both repositories.
304
+
Apify MCP is split across two repositories: this one for core MCP logic and the private `apify-mcp-server-internal` for the hosted server.
305
+
Changes must be synchronized between both.
241
306
242
-
You can create a canary release from your PR branch by adding the `beta` tag. This will test the code and publish the package to [pkg.pr.new](https://pkg.pr.new/) which you can then use, for example, in a staging environment to test before actually merging the changes. This way we do not need to create new NPM releases and keep the NPM versions cleaner. The workflow runs whenever you commit to a PR branch that has the `beta` tag or when you add the `beta` tag to an already existing PR. For more details check out [the workflow file](.github/workflows/pre_release.yaml).
307
+
To create a canary release, add the `beta` tag to your PR branch.
308
+
This publishes the package to [pkg.pr.new](https://pkg.pr.new/) for staging and testing before merging.
309
+
See [the workflow file](.github/workflows/pre_release.yaml) for details.
243
310
244
311
# 🐛 Troubleshooting (local MCP server)
245
312
@@ -262,7 +329,7 @@ The Actor input schema is processed to be compatible with most MCP clients while
262
329
263
330
We welcome contributions to improve the Apify MCP Server! Here's how you can help:
264
331
265
-
-**🐛 Report issues**: Find a bug or have a feature request? [Open an issue](https://github.com/apify/actors-mcp-server/issues).
332
+
-**🐛 Report issues**: Find a bug or have a feature request? [Open an issue](https://github.com/apify/apify-mcp-server/issues).
266
333
-**🔧 Submit pull requests**: Fork the repo and submit pull requests with enhancements or fixes.
267
334
-**📚 Documentation**: Improvements to docs and examples are always welcome.
268
335
-**💡 Share use cases**: Contribute examples to help other users.
0 commit comments