Skip to content

Commit 94fdac3

Browse files
authored
fix: Update type documentation and deprecate SSE transport in favor of Streamable HTTP (#416)
1 parent 0ade868 commit 94fdac3

2 files changed

Lines changed: 14 additions & 6 deletions

File tree

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ Check out the [MCP clients section](#-mcp-clients) for more details or visit the
3333
## Table of Contents
3434
- [🌐 Introducing the Apify MCP server](#-introducing-the-apify-mcp-server)
3535
- [🚀 Quickstart](#-quickstart)
36+
- [⚠️ SSE transport deprecation](#-sse-transport-deprecation)
3637
- [🤖 MCP clients](#-mcp-clients)
3738
- [🪄 Try Apify MCP instantly](#-try-apify-mcp-instantly)
3839
- [🛠️ Tools, resources, and prompts](#-tools-resources-and-prompts)
@@ -69,6 +70,13 @@ You can use the Apify MCP Server in two ways:
6970

7071
You can find detailed instructions for setting up the MCP server in the [Apify documentation](https://docs.apify.com/platform/integrations/mcp).
7172

73+
# ⚠️ SSE transport deprecation on April 1, 2026
74+
75+
Udate your MCP client config before April 1, 2026.
76+
The Apify MCP server is dropping Server-Sent Events (SSE) transport in favor of Streamable HTTP, in line with the official MCP spec.
77+
78+
Go to [mcp.apify.com](https://mcp.apify.com/) to update the installation for your client of choice, with a valid endpoint.
79+
7280
# 🤖 MCP clients
7381

7482
Apify MCP Server is compatible with any MCP client that adheres to the [Model Context Protocol](https://modelcontextprotocol.org/), but the level of support for dynamic tool discovery and other features may vary between clients.

src/types.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -225,9 +225,9 @@ export type ToolSelector = ToolCategory | string;
225225

226226
export type Input = {
227227
/**
228-
* When `actors` is undefined that means the default Actors should be loaded.
229-
* If it as empty string or empty array then no Actors should be loaded.
230-
* Otherwise the specified Actors should be loaded.
228+
* When `actors` is undefined, that means the default Actors should be loaded.
229+
* If it is as an empty string or empty array, then no Actors should be loaded.
230+
* Otherwise, the specified Actors should be loaded.
231231
*/
232232
actors?: string[] | string;
233233
/**
@@ -371,7 +371,7 @@ export type ActorsMcpServerOptions = {
371371
/**
372372
* Enable or disable telemetry tracking for tool calls.
373373
* Must be explicitly set when telemetry object is provided.
374-
* When telemetry object is omitted entirely, defaults to true (via env var or default).
374+
* When a telemetry object is omitted entirely, defaults to true (via env var or default).
375375
*/
376376
enabled: boolean;
377377
/**
@@ -383,11 +383,11 @@ export type ActorsMcpServerOptions = {
383383
};
384384
/**
385385
* Transport type for telemetry tracking.
386-
* Important: this is also used for the long running tasks logic
386+
* Important: this is also used for the long-running tasks logic
387387
* which is different for local and remote server based on the transport type.
388388
* - 'stdio': Direct/local stdio connection
389389
* - 'http': Remote HTTP streamable connection
390-
* - 'sse': Remote Server-Sent Events (SSE) connection
390+
* - 'sse': Remote Server-Sent Events (SSE) connection (deprecated, removal on 2026-04-01)
391391
*/
392392
transportType?: 'stdio' | 'http' | 'sse';
393393
/**

0 commit comments

Comments
 (0)