Skip to content

Commit 4763f51

Browse files
committed
improve readme
1 parent 4944f34 commit 4763f51

File tree

1 file changed

+48
-20
lines changed

1 file changed

+48
-20
lines changed

README.md

Lines changed: 48 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -140,47 +140,75 @@ One of the most powerful features of using MCP with Apify is dynamic tool discov
140140
It gives an AI agent the ability to find new tools (Actors) as needed and incorporate them.
141141
Here are some special MCP operations and how the Apify MCP Server supports them:
142142

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.
144144
- **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.
156147

157148
### Overview of available tools
158149

159150
Here is an overview list of all the tools provided by the Apify MCP Server.
160151

161152
| Tool name | Category | Description | Enabled by default |
162153
| :--- | :--- | :--- | :---: |
163-
| `fetch-actor-details` | actor-discovery | Retrieve detailed information about a specific Actor. ||
164-
| `search-actors` | actor-discovery | Search for Actors in the Apify Store. ||
165-
| `add-actor` | default (see note below) | 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) | Actor (see note below) | 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. ||
167158
| `search-apify-docs` | docs | Search the Apify documentation for relevant pages. ||
168159
| `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. | |
170160
| `get-actor-run` | runs | Get detailed information about a specific Actor run. | |
171161
| `get-actor-run-list` | runs | Get a list of an Actor's runs, filterable by status. | |
172162
| `get-actor-log` | runs | Retrieve the logs for a specific Actor run. | |
173163
| `get-dataset` | storage | Get metadata about a specific dataset. | |
174164
| `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. | |
175166
| `get-key-value-store` | storage | Get metadata about a specific key-value store. | |
176167
| `get-key-value-store-keys`| storage | List the keys within a specific key-value store. | |
177168
| `get-key-value-store-record`| storage | Get the value associated with a specific key in a key-value store. | |
178169
| `get-dataset-list` | storage | List all available datasets for the user. | |
179170
| `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+
It is thus the same as if you configured the `tools` parameter like this:
184+
185+
**For the hosted server:**
186+
```
187+
https://mcp.apify.com?tools=actors,docs,apify/rag-web-browser
188+
```
189+
190+
**For the CLI:**
191+
```bash
192+
npx @apify/actors-mcp-server --tools actors,docs,apify/rag-web-browser
193+
```
194+
195+
If the tools parameter is specified, only the listed tools or categories will be enabled - no default tools will be included.
196+
197+
> **⚠️ Important Recommendation**
198+
>
199+
> **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.
200+
>
201+
> **For production use and stable interfaces, always explicitly specify the `tools` parameter** to ensure your configuration remains consistent across updates.
202+
203+
**Minimal configuration**
204+
205+
For example, to use only a single Actor tool - without any discovery or generic calling tools, the server can be configured like this:
206+
207+
```
208+
https://mcp.apify.com?tools=apify/my-actor
209+
```
180210

181-
> **Note:**
182-
> The `add-actor` tool is always enabled by default and does not explicitly belong to any category. Currently, it can be disabled by setting `?enableAddingActors=false` or `--enable-adding-actors false`.
183-
> The `apify-slash-rag-web-browser` is an Apify Actor tool loaded by default. You can disable it by loading a different set of Actors using `?actors=other/actor` or `--actors other/actor`, or you can disable pre-loading of Actors by setting `?actors=` or `--actors=` (to an empty string).
211+
This setup exposes only the specified Actor (`apify/my-actor`) as a tool. No other tools will be available.
184212

185213
### Prompts
186214

0 commit comments

Comments
 (0)