Skip to content

Commit 220e1cc

Browse files
feat: Update MCP docs with telemetry info (#2117)
<!-- CURSOR_SUMMARY --> > [!NOTE] > Adds telemetry documentation with opt-out instructions and fixes the tools table for runs/storage entries. > > - **Docs (MCP server)** > - **Telemetry**: Add section detailing anonymous data collection, default enablement, and opt-out methods for both remote (`?telemetry-enabled=false`) and local stdio (`--telemetry-enabled=false` or env) servers. > - **Available tools table**: Fix and normalize entries for `runs` and `storage` tools (`get-actor-run*`, `get-dataset*`, `get-key-value-store*`), ensuring proper formatting and visibility. > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit c702337. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <!-- /CURSOR_SUMMARY --> close: #2117 --------- Co-authored-by: Marcel Rebro <marcel.rebro@apify.com>
1 parent d27d34e commit 220e1cc

File tree

1 file changed

+54
-11
lines changed
  • sources/platform/integrations/ai

1 file changed

+54
-11
lines changed

sources/platform/integrations/ai/mcp.md

Lines changed: 54 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -277,17 +277,17 @@ Use the UI configurator `https://mcp.apify.com/` to select your tools visually,
277277
| [`apify/rag-web-browser`](https://apify.com/apify/rag-web-browser) | Actor || Browse and extract web data |
278278
| `search-apify-docs` | docs || Search the Apify documentation for relevant pages |
279279
| `fetch-apify-docs` | docs || Fetch the full content of an Apify documentation page by its URL |
280-
| `get-actor-run` | runs | | Get detailed information about a specific Actor run |
281-
| `get-actor-run-list` | runs | | Get a list of an Actor's runs, filterable by status |
282-
| `get-actor-log` | runs | | Retrieve the logs for a specific Actor run |
283-
| `get-dataset` | storage | | Get metadata about a specific dataset |
284-
| `get-dataset-items` | storage | | Retrieve items from a dataset with support for filtering and pagination |
285-
| `get-dataset-schema` | storage | | Generate a JSON schema from dataset items |
286-
| `get-key-value-store` | storage | | Get metadata about a specific key-value store |
287-
| `get-key-value-store-keys`| storage | | List the keys within a specific key-value store |
288-
| `get-key-value-store-record`| storage | | Get the value associated with a specific key in a key-value store |
289-
| `get-dataset-list` | storage | | List all available datasets for the user |
290-
| `get-key-value-store-list`| storage | | List all available key-value stores for the user |
280+
| `get-actor-run` | runs | | Get detailed information about a specific Actor run |
281+
| `get-actor-run-list` | runs | | Get a list of an Actor's runs, filterable by status |
282+
| `get-actor-log` | runs | | Retrieve the logs for a specific Actor run |
283+
| `get-dataset` | storage | | Get metadata about a specific dataset |
284+
| `get-dataset-items` | storage | | Retrieve items from a dataset with support for filtering and pagination |
285+
| `get-dataset-schema` | storage | | Generate a JSON schema from dataset items |
286+
| `get-key-value-store` | storage | | Get metadata about a specific key-value store |
287+
| `get-key-value-store-keys` | storage | | List the keys within a specific key-value store |
288+
| `get-key-value-store-record` | storage | | Get the value associated with a specific key in a key-value store |
289+
| `get-dataset-list` | storage | | List all available datasets for the user |
290+
| `get-key-value-store-list` | storage | | List all available key-value stores for the user |
291291
| `add-actor`* | experimental || Add an Actor as a new tool for the user to call |
292292
| `get-actor-output`* | - || Retrieve the output from an Actor call which is not included in the output preview of the Actor tool. |
293293

@@ -314,6 +314,49 @@ For a detailed overview of client support for dynamic discovery, see the [MCP cl
314314

315315
:::
316316

317+
## Telemetry
318+
319+
The MCP server collects telemetry data about tool calls and MCP clients to help Apify understand usage patterns and improve the service.
320+
Participation in this program is optional and you may opt out if you prefer not to share any information.
321+
322+
### Data collection
323+
324+
All telemetry data is collected and stored securely.
325+
We do not collect any sensitive information such as conversations, arguments passed to tools, API tokens, or personal data.
326+
327+
The server collects anonymous information about tool usage, including:
328+
329+
- Basic information about used tools (calls, success/failure, duration)
330+
- MCP client attributes (client name, version, capabilities)
331+
332+
By default, telemetry is _enabled_ for all tool calls.
333+
334+
### Opt out of telemetry
335+
336+
#### Remote server
337+
338+
For the remote server (`mcp.apify.com`), you can opt out of telemetry by adding the `telemetry-enabled=false` query parameter to the server URL:
339+
340+
```text
341+
https://mcp.apify.com?telemetry-enabled=false
342+
```
343+
344+
#### Local stdio server
345+
346+
For the local stdio server, opt out of telemetry using a CLI flag or an environment variable. When both the CLI flag and environment variable are set, the CLI flag takes precedence.
347+
348+
- _CLI flag_: set the `--telemetry-enabled` CLI flag to `false`:
349+
350+
```bash
351+
npx @apify/actors-mcp-server --telemetry-enabled=false
352+
```
353+
354+
- _Environment variable_: set the `TELEMETRY_ENABLED` environment variable to `false`:
355+
356+
```bash
357+
export TELEMETRY_ENABLED=false
358+
npx @apify/actors-mcp-server
359+
```
317360

318361
## Advanced usage
319362

0 commit comments

Comments
 (0)