Streamable HTTP CLI flag (#3394)

This commit is contained in:
Angie Jones
2025-07-13 18:09:04 -05:00
committed by GitHub
parent 192a8077dc
commit 1987956422
7 changed files with 203 additions and 10 deletions

View File

@@ -291,6 +291,26 @@ For example, a deeplink for a URL like `http://localhost:8080/sse` would look li
```
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">
```
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
- `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
- `name`: Display name for the extension
- `description`: Brief description of the extension's functionality
For example, a deeplink for a URL like `https://example.com/streamable` would look like this when URL-encoded:
```
goose://extension?url=https%3A%2F%2Fexample.com%2Fstreamable&type=streamable_http&timeout=<timeout>&id=<id>&name=<n>&description=<description>
```
</TabItem>
@@ -598,8 +618,22 @@ For example, to start a session with a remote extension over SSE running on loca
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:
```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:
```bash
goose session --with-streamable-http-extension "https://example.com/streamable"
```
## Developing Extensions
Goose extensions are implemented with MCP, a standard protocol that allows AI models and agents to securely connect with local or remote resources. Learn how to build your own [extension as an MCP server](https://modelcontextprotocol.io/quickstart/server).
[extensions-directory]: https://block.github.io/goose/v1/extensions
[extensions-directory]: https://block.github.io/goose/v1/extensions