docs: remove SSE transport and rename to Streamable HTTP (#6319)
Signed-off-by: Adrian Cole <adrian@tetrate.io>
This commit is contained in:
@@ -153,8 +153,7 @@ See available servers in the **[MCP Server Directory](https://www.pulsemcp.com/s
|
||||
3. Choose the type of extension you'd like to add:
|
||||
- `Built-In Extension`: Use an extension that comes pre-installed with goose.
|
||||
- `Command-Line Extension`: Add a local command or script to run as an extension.
|
||||
- `Remote Extension (SSE)`: Connect to a remote system via SSE (Server-Sent Events).
|
||||
- `Remote Extension (Streaming HTTP)`: Connect to a remote system via Streaming HTTP
|
||||
- `Remote Extension (Streamable HTTP)`: Connect to a remote system via Streamable HTTP
|
||||
|
||||
4. Follow the prompts based on the type of extension you selected.
|
||||
|
||||
@@ -284,32 +283,13 @@ goose://extension?cmd=npx&arg=-y&arg=%40modelcontextprotocol/server-github&timeo
|
||||
|
||||
Note that each parameter to the `npx` command is passed as a separate `arg` parameter in the deeplink.
|
||||
</TabItem>
|
||||
<TabItem value="sse" label="Server-Sent Events">
|
||||
```
|
||||
goose://extension?url=<remote-sse-url>&id=<id>&name=<name>&description=<description>
|
||||
```
|
||||
|
||||
Parameters:
|
||||
- `url`: The URL of the remote SSE server
|
||||
- `timeout`: Maximum time (in seconds) to wait for extension responses
|
||||
- `id`: Unique identifier for the extension
|
||||
- `name`: Display name for the extension
|
||||
- `description`: Brief description of the extension's functionality
|
||||
|
||||
For example, a deeplink for a URL like `http://localhost:8080/sse` would look like this when URL-encoded:
|
||||
|
||||
```
|
||||
goose://extension?url=http%3A%2F%2Flocalhost%3A8080%2Fsse&timeout=<timeout>&id=<id>&name=<name>&description=<description>>
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="streamable_http" label="Streaming HTTP">
|
||||
<TabItem value="streamable_http" label="Streamable HTTP">
|
||||
```
|
||||
goose://extension?url=<remote-streamable-http-url>&type=streamable_http&id=<id>&name=<n>&description=<description>
|
||||
```
|
||||
|
||||
Parameters:
|
||||
- `url`: The URL of the remote Streaming HTTP server
|
||||
- `url`: The URL of the remote Streamable HTTP server
|
||||
- `type`: Must be set to `streamable_http` to specify the protocol type
|
||||
- `timeout`: Maximum time (in seconds) to wait for extension responses
|
||||
- `id`: Unique identifier for the extension
|
||||
@@ -636,29 +616,15 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
|
||||
:::
|
||||
|
||||
|
||||
### Remote Extensions over SSE
|
||||
### Remote Extensions over Streamable HTTP
|
||||
|
||||
To enable a remote extension over SSE while starting a session, run the following command:
|
||||
|
||||
```bash
|
||||
goose session --with-remote-extension "{extension URL}" --with-remote-extension "{another extension URL}"
|
||||
```
|
||||
|
||||
For example, to start a session with a remote extension over SSE running on localhost on port 8080, you'd run:
|
||||
|
||||
```bash
|
||||
goose session --with-remote-extension "http://localhost:8080/sse"
|
||||
```
|
||||
|
||||
### Remote Extensions over Streaming HTTP
|
||||
|
||||
To enable a remote extension over Streaming HTTP while starting a session, run the following command:
|
||||
To enable a remote extension over Streamable HTTP while starting a session, run the following command:
|
||||
|
||||
```bash
|
||||
goose session --with-streamable-http-extension "{extension URL}" --with-streamable-http-extension "{another extension URL}"
|
||||
```
|
||||
|
||||
For example, to start a session with a Streaming HTTP extension, you'd run:
|
||||
For example, to start a session with a Streamable HTTP extension, you'd run:
|
||||
|
||||
```bash
|
||||
goose session --with-streamable-http-extension "https://example.com/streamable"
|
||||
|
||||
Reference in New Issue
Block a user