Skip to content

Commit 9a5c16a

Browse files
authored
docs: update tool selection section (#174)
update readme tool selection section
1 parent b6f146e commit 9a5c16a

File tree

2 files changed

+24
-6
lines changed

2 files changed

+24
-6
lines changed

.actor/ACTOR.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -93,11 +93,19 @@ You don't need to specify which Actor to call or what its input parameters are;
9393
### Helper tools
9494
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:
9595

96-
- Actor discovery and management: Search for Actors (`search-actors`), view details (`get-actor-details`), and dynamically add or remove tools (`add-actor`, `remove-actor`).
97-
- Actor execution and monitoring: Start Actor runs, fetch run results (`get-actor-run`), logs (`get-actor-log`), and abort runs (`abort-actor-run`).
98-
- Dataset access: List datasets, retrieve dataset info and items (`get-dataset`, `get-dataset-list`, `get-dataset-items`).
99-
- 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`).
100-
- Built-in help tool: A static helper (`apify-actor-help-tool`) that returns usage info for the Apify MCP Server.
96+
- Actor discovery and management: Search for Actors (`search-actors`), view details (`get-actor-details`), and dynamically add them (`add-actor`).
97+
- Apify documentation: Search Apify documentation (`search-apify-docs`) and fetch specific documents (`fetch-apify-docs`).
98+
- Actor runs (*): Get a list of your Actor runs (`get-actor-run-list`), specific run details (`get-actor-run`), and logs from a specific Actor run (`get-actor-log`).
99+
- Apify storage (*): Access datasets (`get-dataset`, `get-dataset-items`, `get-dataset-list`), key-value stores (`get-key-value-store`, `get-key-value-store-keys`, `get-key-value-store-record`, `get-key-value-store-records`), and their records.
100+
101+
Note: Helper tool categories marked with (*) are not enabled by default in the MCP server and must be explicitly enabled using the `?tools` URL query parameter. The `tools` parameter is a comma-separated list of categories with the following possible values:
102+
103+
- `docs`: Search and fetch Apify documentation tools.
104+
- `runs`: Get Actor runs list, run details, and logs from a specific Actor run.
105+
- `storage`: Access datasets, key-value stores, and their records.
106+
- `preview`: Experimental tools in preview mode.
107+
108+
For example, to enable all tools, use `https://actors-mcp-server.apify.actor/?tools=docs,runs,storage,preview`.
101109

102110
## Prompt & Resources
103111

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,17 @@ One of the powerful features of MCP with Apify is dynamic actor tooling – the
9494

9595
- Actor discovery and management: Search for Actors (`search-actors`), view details (`get-actor-details`), and dynamically add them (`add-actor`).
9696
- Apify documentation: Search Apify documentation (`search-apify-docs`) and fetch specific documents (`fetch-apify-docs`).
97-
- Built-in help tool: A static helper (`apify-actor-help-tool`) that returns usage info for the Apify MCP Server.
97+
- Actor runs (*): Get a list of your Actor runs (`get-actor-run-list`), specific run details (`get-actor-run`), and logs from a specific Actor run (`get-actor-log`).
98+
- Apify storage (*): Access datasets (`get-dataset`, `get-dataset-items`, `get-dataset-list`), key-value stores (`get-key-value-store`, `get-key-value-store-keys`, `get-key-value-store-record`, `get-key-value-store-records`), and their records.
99+
100+
**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:
101+
102+
- `docs`: Search and fetch Apify documentation tools.
103+
- `runs`: Get Actor runs list, run details, and logs from a specific Actor run.
104+
- `storage`: Access datasets, key-value stores, and their records.
105+
- `preview`: Experimental tools in preview mode.
106+
107+
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`.
98108

99109
## Prompt & Resources
100110

0 commit comments

Comments
 (0)