docs: Show both remote options for extensions in CLI (#3392)

This commit is contained in:
Angie Jones
2025-07-13 15:31:21 -05:00
committed by GitHub
parent 9de90bc272
commit 192a8077dc
34 changed files with 211 additions and 173 deletions

View File

@@ -54,7 +54,8 @@ Here are the built-in extensions:
3. Choose the type of extension you'd like to add: 3. Choose the type of extension you'd like to add:
- `Built-In Extension`: Use an extension that comes pre-installed with Goose. - `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. - `Command-Line Extension`: Add a local command or script to run as an extension.
- `Remote Extension`: Connect to a remote system via SSE (Server-Sent Events). - `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
4. Follow the prompts based on the type of extension you selected. 4. Follow the prompts based on the type of extension you selected.
**Example: Adding Built-in Extension** **Example: Adding Built-in Extension**
@@ -143,7 +144,8 @@ See available servers in the **[MCP Server Directory](https://www.pulsemcp.com/s
3. Choose the type of extension you'd like to add: 3. Choose the type of extension you'd like to add:
- `Built-In Extension`: Use an extension that comes pre-installed with Goose. - `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. - `Command-Line Extension`: Add a local command or script to run as an extension.
- `Remote Extension`: Connect to a remote system via SSE (Server-Sent Events). - `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
4. Follow the prompts based on the type of extension you selected. 4. Follow the prompts based on the type of extension you selected.
@@ -590,7 +592,7 @@ To enable a remote extension over SSE while starting a session, run the followin
goose session --with-remote-extension "{extension URL}" --with-remote-extension "{another extension URL}" goose session --with-remote-extension "{extension URL}" --with-remote-extension "{another extension URL}"
``` ```
For example, to start a session with a remote extension running on localhost on port 8080, you'd run: For example, to start a session with a remote extension over SSE running on localhost on port 8080, you'd run:
```bash ```bash
goose session --with-remote-extension "http://localhost:8080/sse" goose session --with-remote-extension "http://localhost:8080/sse"

View File

@@ -114,7 +114,7 @@ goose run --with-builtin "developer,computercontroller" -t "your instructions"
goose run --with-extension "ENV1=value1 custom-extension-args" -t "your instructions" goose run --with-extension "ENV1=value1 custom-extension-args" -t "your instructions"
``` ```
- Using remote extensions - Using remote SSE extensions
```bash ```bash
goose run --with-remote-extension "url" -t "your instructions" goose run --with-remote-extension "url" -t "your instructions"

View File

@@ -61,7 +61,8 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
// highlight-start // highlight-start
│ ● Command-line Extension (Run a local command or script) │ ● Command-line Extension (Run a local command or script)
// highlight-end // highlight-end
│ ○ Remote Extension │ ○ Remote Extension (SSE)
│ ○ Remote Extension (Streaming HTTP)
``` ```

View File

@@ -66,7 +66,8 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
// highlight-start // highlight-start
│ ● Command-line Extension (Run a local command or script) │ ● Command-line Extension (Run a local command or script)
// highlight-end // highlight-end
│ ○ Remote Extension │ ○ Remote Extension (SSE)
│ ○ Remote Extension (Streaming HTTP)
``` ```

View File

@@ -74,7 +74,8 @@ Note that you'll need [uv](https://docs.astral.sh/uv/#installation) installed on
// highlight-start // highlight-start
│ ● Command-line Extension (Run a local command or script) │ ● Command-line Extension (Run a local command or script)
// highlight-end // highlight-end
│ ○ Remote Extension │ ○ Remote Extension (SSE)
│ ○ Remote Extension (Streaming HTTP)
``` ```

View File

@@ -61,7 +61,8 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
// highlight-start // highlight-start
│ ● Command-line Extension (Run a local command or script) │ ● Command-line Extension (Run a local command or script)
// highlight-end // highlight-end
│ ○ Remote Extension │ ○ Remote Extension (SSE)
│ ○ Remote Extension (Streaming HTTP)
``` ```

View File

@@ -56,7 +56,8 @@ This tutorial covers how to add the Browserbase MCP Server as a Goose extension
// highlight-start // highlight-start
│ ● Command-line Extension (Run a local command or script) │ ● Command-line Extension (Run a local command or script)
// highlight-end // highlight-end
│ ○ Remote Extension │ ○ Remote Extension (SSE)
│ ○ Remote Extension (Streaming HTTP)
``` ```

View File

@@ -59,7 +59,8 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
// highlight-start // highlight-start
│ ● Command-line Extension (Run a local command or script) │ ● Command-line Extension (Run a local command or script)
// highlight-end // highlight-end
│ ○ Remote Extension │ ○ Remote Extension (SSE)
│ ○ Remote Extension (Streaming HTTP)
``` ```

View File

@@ -58,7 +58,8 @@ goose configure
// highlight-start // highlight-start
│ ● Command-line Extension (Run a local command or script) │ ● Command-line Extension (Run a local command or script)
// highlight-end // highlight-end
│ ○ Remote Extension │ ○ Remote Extension (SSE)
│ ○ Remote Extension (Streaming HTTP)
``` ```

View File

@@ -46,7 +46,8 @@ Let Goose complete its tasks without interruption - avoid using your mouse or ke
│ ● Built-in Extension (Use an extension that comes with Goose) │ ● Built-in Extension (Use an extension that comes with Goose)
// highlight-end // highlight-end
│ ○ Command-line Extension │ ○ Command-line Extension
│ ○ Remote Extension │ ○ Remote Extension (SSE)
│ ○ Remote Extension (Streaming HTTP)
``` ```

View File

@@ -62,7 +62,8 @@ Note that you'll need [uv](https://docs.astral.sh/uv/#installation) installed on
// highlight-start // highlight-start
│ ● Command-line Extension (Run a local command or script) │ ● Command-line Extension (Run a local command or script)
// highlight-end // highlight-end
│ ○ Remote Extension │ ○ Remote Extension (SSE)
│ ○ Remote Extension (Streaming HTTP)
``` ```

View File

@@ -58,7 +58,8 @@ Note that you'll need [uv](https://docs.astral.sh/uv/#installation) installed on
// highlight-start // highlight-start
│ ● Command-line Extension (Run a local command or script) │ ● Command-line Extension (Run a local command or script)
// highlight-end // highlight-end
│ ○ Remote Extension │ ○ Remote Extension (SSE)
│ ○ Remote Extension (Streaming HTTP)
``` ```

View File

@@ -62,7 +62,8 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
// highlight-start // highlight-start
│ ● Command-line Extension (Run a local command or script) │ ● Command-line Extension (Run a local command or script)
// highlight-end // highlight-end
│ ○ Remote Extension │ ○ Remote Extension (SSE)
│ ○ Remote Extension (Streaming HTTP)
``` ```

View File

@@ -57,7 +57,8 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
// highlight-start // highlight-start
│ ● Command-line Extension (Run a local command or script) │ ● Command-line Extension (Run a local command or script)
// highlight-end // highlight-end
│ ○ Remote Extension │ ○ Remote Extension (SSE)
│ ○ Remote Extension (Streaming HTTP)
``` ```

View File

@@ -129,7 +129,8 @@ You'll need to re-authenticate once a day when using the Google Drive extension.
// highlight-start // highlight-start
│ ● Command-line Extension (Run a local command or script) │ ● Command-line Extension (Run a local command or script)
// highlight-end // highlight-end
│ ○ Remote Extension │ ○ Remote Extension (SSE)
│ ○ Remote Extension (Streaming HTTP)
``` ```

View File

@@ -60,7 +60,8 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
// highlight-start // highlight-start
│ ● Command-line Extension (Run a local command or script) │ ● Command-line Extension (Run a local command or script)
// highlight-end // highlight-end
│ ○ Remote Extension │ ○ Remote Extension (SSE)
│ ○ Remote Extension (Streaming HTTP)
``` ```

View File

@@ -44,7 +44,8 @@ This tutorial covers how to enable and use the JetBrains MCP Server as a built-i
│ ● Built-in Extension (Use an extension that comes with Goose) │ ● Built-in Extension (Use an extension that comes with Goose)
// highlight-end // highlight-end
│ ○ Command-line Extension │ ○ Command-line Extension
│ ○ Remote Extension │ ○ Remote Extension (SSE)
│ ○ Remote Extension (Streaming HTTP)
``` ```

View File

@@ -56,7 +56,8 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
// highlight-start // highlight-start
│ ● Command-line Extension (Run a local command or script) │ ● Command-line Extension (Run a local command or script)
// highlight-end // highlight-end
│ ○ Remote Extension │ ○ Remote Extension (SSE)
│ ○ Remote Extension (Streaming HTTP)
``` ```

View File

@@ -59,7 +59,8 @@ This tutorial will get you started with [deemkeen's MQTT MCP server](https://git
// highlight-start // highlight-start
│ ● Command-line Extension (Run a local command or script) │ ● Command-line Extension (Run a local command or script)
// highlight-end // highlight-end
│ ○ Remote Extension │ ○ Remote Extension (SSE)
│ ○ Remote Extension (Streaming HTTP)
``` ```

View File

@@ -43,7 +43,8 @@ This tutorial covers enabling and using the Memory MCP Server, which is a built-
│ ● Built-in Extension (Use an extension that comes with Goose) │ ● Built-in Extension (Use an extension that comes with Goose)
// highlight-end // highlight-end
│ ○ Command-line Extension │ ○ Command-line Extension
│ ○ Remote Extension │ ○ Remote Extension (SSE)
│ ○ Remote Extension (Streaming HTTP)
``` ```

View File

@@ -62,7 +62,8 @@ netlify login
// highlight-start // highlight-start
│ ● Command-line Extension (Run a local command or script) │ ● Command-line Extension (Run a local command or script)
// highlight-end // highlight-end
│ ○ Remote Extension │ ○ Remote Extension (SSE)
│ ○ Remote Extension (Streaming HTTP)
``` ```

View File

@@ -52,7 +52,8 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
// highlight-start // highlight-start
│ ● Command-line Extension (Run a local command or script) │ ● Command-line Extension (Run a local command or script)
// highlight-end // highlight-end
│ ○ Remote Extension │ ○ Remote Extension (SSE)
│ ○ Remote Extension (Streaming HTTP)
``` ```

View File

@@ -57,7 +57,8 @@ Note that you'll need [uv](https://docs.astral.sh/uv/#installation) installed on
// highlight-start // highlight-start
│ ● Command-line Extension (Run a local command or script) │ ● Command-line Extension (Run a local command or script)
// highlight-end // highlight-end
│ ○ Remote Extension │ ○ Remote Extension (SSE)
│ ○ Remote Extension (Streaming HTTP)
``` ```

View File

@@ -56,11 +56,13 @@ http://localhost:39300/model_context_protocol/2024-11-05/sse
│ ○ Built-in Extension │ ○ Built-in Extension
│ ○ Command-line Extension (Run a local command or script) │ ○ Command-line Extension (Run a local command or script)
// highlight-start // highlight-start
│ ● Remote Extension │ ● Remote Extension (SSE)
// highlight-end // highlight-end
│ ○ Remote Extension (Streaming HTTP)
``` ```
3. Give your extension a name 3. Give your extension a name
```sh ```sh
@@ -70,7 +72,7 @@ http://localhost:39300/model_context_protocol/2024-11-05/sse
│ Add Extension (Connect to a new extension) │ Add Extension (Connect to a new extension)
◇ What type of extension would you like to add? ◇ What type of extension would you like to add?
│ Remote Extension │ Remote Extension (SSE)
// highlight-start // highlight-start
◆ What would you like to call this extension? ◆ What would you like to call this extension?
@@ -92,7 +94,7 @@ http://localhost:39300/model_context_protocol/2024-11-05/sse
│ Add Extension (Connect to a new extension) │ Add Extension (Connect to a new extension)
◇ What type of extension would you like to add? ◇ What type of extension would you like to add?
│ Remote Extension │ Remote Extension (SSE)
◇ What would you like to call this extension? ◇ What would you like to call this extension?
│ Pieces │ Pieces
@@ -113,7 +115,7 @@ http://localhost:39300/model_context_protocol/2024-11-05/sse
│ Add Extension (Connect to a new extension) │ Add Extension (Connect to a new extension)
◇ What type of extension would you like to add? ◇ What type of extension would you like to add?
│ Remote Extension │ Remote Extension (SSE)
◇ What would you like to call this extension? ◇ What would you like to call this extension?
│ Pieces │ Pieces
@@ -137,7 +139,7 @@ http://localhost:39300/model_context_protocol/2024-11-05/sse
│ Add Extension (Connect to a new extension) │ Add Extension (Connect to a new extension)
◇ What type of extension would you like to add? ◇ What type of extension would you like to add?
│ Remote Extension │ Remote Extension (SSE)
◇ What would you like to call this extension? ◇ What would you like to call this extension?
│ Pieces │ Pieces
@@ -165,7 +167,7 @@ http://localhost:39300/model_context_protocol/2024-11-05/sse
│ Add Extension (Connect to a new extension) │ Add Extension (Connect to a new extension)
◇ What type of extension would you like to add? ◇ What type of extension would you like to add?
│ Remote Extension │ Remote Extension (SSE)
◇ What would you like to call this extension? ◇ What would you like to call this extension?
│ Pieces │ Pieces

View File

@@ -52,8 +52,11 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
◆ What type of extension would you like to add? ◆ What type of extension would you like to add?
│ ○ Built-in Extension │ ○ Built-in Extension
// highlight-start
│ ● Command-line Extension (Run a local command or script) │ ● Command-line Extension (Run a local command or script)
│ ○ Remote Extension // highlight-end
│ ○ Remote Extension (SSE)
│ ○ Remote Extension (Streaming HTTP)
``` ```

View File

@@ -84,7 +84,8 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
// highlight-start // highlight-start
│ ● Command-line Extension (Run a local command or script) │ ● Command-line Extension (Run a local command or script)
// highlight-end // highlight-end
│ ○ Remote Extension │ ○ Remote Extension (SSE)
│ ○ Remote Extension (Streaming HTTP)
``` ```

View File

@@ -56,7 +56,8 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
// highlight-start // highlight-start
│ ● Command-line Extension (Run a local command or script) │ ● Command-line Extension (Run a local command or script)
// highlight-end // highlight-end
│ ○ Remote Extension │ ○ Remote Extension (SSE)
│ ○ Remote Extension (Streaming HTTP)
``` ```

View File

@@ -57,7 +57,8 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
// highlight-start // highlight-start
│ ● Command-line Extension (Run a local command or script) │ ● Command-line Extension (Run a local command or script)
// highlight-end // highlight-end
│ ○ Remote Extension │ ○ Remote Extension (SSE)
│ ○ Remote Extension (Streaming HTTP)
``` ```

View File

@@ -58,7 +58,8 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
// highlight-start // highlight-start
│ ● Command-line Extension (Run a local command or script) │ ● Command-line Extension (Run a local command or script)
// highlight-end // highlight-end
│ ○ Remote Extension │ ○ Remote Extension (SSE)
│ ○ Remote Extension (Streaming HTTP)
``` ```

View File

@@ -63,7 +63,8 @@ Before adding this extension, make sure [PortAudio](https://github.com/GoogleClo
// highlight-start // highlight-start
│ ● Command-line Extension (Run a local command or script) │ ● Command-line Extension (Run a local command or script)
// highlight-end // highlight-end
│ ○ Remote Extension │ ○ Remote Extension (SSE)
│ ○ Remote Extension (Streaming HTTP)
``` ```

View File

@@ -58,142 +58,143 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
4. It will ask you to login or reauthenticate to Square, and may ask you to confirm the permissions you want to allow. 4. It will ask you to login or reauthenticate to Square, and may ask you to confirm the permissions you want to allow.
</TabItem> </TabItem>
<TabItem value="cli" label="Goose CLI"> <TabItem value="cli" label="Goose CLI">
1. Run the `configure` command: 1. Run the `configure` command:
```sh ```sh
goose configure goose configure
```
2. Choose to add a `Command-line Extension`
```sh
┌ goose-configure
◇ What would you like to configure?
│ Add Extension (Connect to a new extension)
◆ What type of extension would you like to add?
│ ○ Built-in Extension
│ ○ Command-line Extension (Run a local command or script)
// highlight-start
│ ● Remote Extension (SSE)
// highlight-end
│ ○ Remote Extension (Streaming HTTP)
```
3. Give your extension a name
```sh
┌ goose-configure
◇ What would you like to configure?
│ Add Extension (Connect to a new extension)
◇ What type of extension would you like to add?
│ Remote Extension (SSE)
// highlight-start
◆ What would you like to call this extension?
│ square-mcp-remote
// highlight-end
``` ```
1. Choose to add a `Command-line Extension` 4. Enter the SSE URI
```sh ```sh
┌ goose-configure ┌ goose-configure
◇ What would you like to configure? ◇ What would you like to configure?
│ Add Extension (Connect to a new extension) │ Add Extension (Connect to a new extension)
What type of extension would you like to add? What type of extension would you like to add?
○ Built-in Extension Remote Extension (SSE)
○ Command-line Extension (Run a local command or script)
// highlight-start ◇ What would you like to call this extension?
● Remote Extension square-mcp-remote
// highlight-end
// highlight-start
``` ◆ What is the SSE endpoint URI?
│ https://mcp.squareup.com/sse
// highlight-end
```
1. Give your extension a name 5. Enter the number of seconds Goose should wait for actions to complete before timing out. Default is 300s
```sh ```sh
┌ goose-configure ┌ goose-configure
◇ What would you like to configure? ◇ What would you like to configure?
│ Add Extension (Connect to a new extension) │ Add Extension (Connect to a new extension)
◇ What type of extension would you like to add? ◇ What type of extension would you like to add?
│ Remote Extension │ Remote Extension (SSE)
// highlight-start ◇ What would you like to call this extension?
What would you like to call this extension? │ square-mcp-remote
square-mcp-remote
// highlight-end ◆ What is the SSE endpoint URI?
│ https://mcp.squareup.com/sse
```
// highlight-start
◆ Please set the timeout for this tool (in secs):
│ 300
// highlight-end
```
1. Enter the SSE URI 6. Choose to add a description. If you select "Yes" here, you will be prompted to enter a description for the extension.
```sh ```sh
┌ goose-configure ┌ goose-configure
◇ What would you like to configure? ◇ What would you like to configure?
│ Add Extension (Connect to a new extension) │ Add Extension (Connect to a new extension)
◇ What type of extension would you like to add? ◇ What type of extension would you like to add?
│ Remote Extension │ Remote Extension (SSE)
◇ What would you like to call this extension? ◇ What would you like to call this extension?
│ square-mcp-remote │ square-mcp-remote
// highlight-start ◆ What is the SSE endpoint URI?
◆ What is the SSE endpoint URI? │ https://mcp.squareup.com/sse
https://mcp.squareup.com/sse
// highlight-end ◆ Please set the timeout for this tool (in secs):
│ 300
```
// highlight-start
◇ Would you like to add a description?
│ No
// highlight-end
```
1. Enter the number of seconds Goose should wait for actions to complete before timing out. Default is 300s 7. Obtain a [Square Access Token](https://developer.squareup.com/apps) and paste it in.
```sh ```sh
┌ goose-configure ┌ goose-configure
◇ What would you like to configure? ◇ What would you like to configure?
│ Add Extension (Connect to a new extension) │ Add Extension (Connect to a new extension)
◇ What type of extension would you like to add? ◇ What type of extension would you like to add?
│ Remote Extension │ Remote Extension (SSE)
◇ What would you like to call this extension? ◇ What would you like to call this extension?
│ square-mcp-remote │ square-mcp-remote
◆ What is the SSE endpoint URI? ◆ What is the SSE endpoint URI?
│ https://mcp.squareup.com/sse │ https://mcp.squareup.com/sse
// highlight-start ◇ Please set the timeout for this tool (in secs):
Please set the timeout for this tool (in secs): │ 300
300
// highlight-end ◇ Would you like to add a description?
│ No
```
// highlight-start
1. Choose to add a description. If you select "Yes" here, you will be prompted to enter a description for the extension. ◆ Would you like to add environment variables?
```sh │ No
goose-configure // highlight-end
What would you like to configure? └ Added square-mcp-remote extension
│ Add Extension (Connect to a new extension) ```
◇ What type of extension would you like to add?
│ Remote Extension
◇ What would you like to call this extension?
│ square-mcp-remote
◆ What is the SSE endpoint URI?
│ https://mcp.squareup.com/sse
◆ Please set the timeout for this tool (in secs):
│ 300
// highlight-start
◇ Would you like to add a description?
│ No
// highlight-end
```
1. Obtain a [Square Access Token](https://developer.squareup.com/apps) and paste it in.
```sh
┌ goose-configure
◇ What would you like to configure?
│ Add Extension (Connect to a new extension)
◇ What type of extension would you like to add?
│ Remote Extension
◇ What would you like to call this extension?
│ square-mcp-remote
◆ What is the SSE endpoint URI?
│ https://mcp.squareup.com/sse
◇ Please set the timeout for this tool (in secs):
│ 300
◇ Would you like to add a description?
│ No
// highlight-start
◆ Would you like to add environment variables?
│ No
// highlight-end
└ Added square-mcp-remote extension
```
</TabItem> </TabItem>
</Tabs> </Tabs>
@@ -256,7 +257,8 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
// highlight-start // highlight-start
│ ● Command-line Extension (Run a local command or script) │ ● Command-line Extension (Run a local command or script)
// highlight-end // highlight-end
│ ○ Remote Extension │ ○ Remote Extension (SSE)
│ ○ Remote Extension (Streaming HTTP)
``` ```

View File

@@ -61,7 +61,8 @@ Note that you'll need [uv](https://docs.astral.sh/uv/#installation) installed on
// highlight-start // highlight-start
│ ● Command-line Extension (Run a local command or script) │ ● Command-line Extension (Run a local command or script)
// highlight-end // highlight-end
│ ○ Remote Extension │ ○ Remote Extension (SSE)
│ ○ Remote Extension (Streaming HTTP)
``` ```

View File

@@ -41,7 +41,8 @@ goose configure
│ ● Built-in Extension (Use an extension that comes with Goose) │ ● Built-in Extension (Use an extension that comes with Goose)
// highlight-end // highlight-end
│ ○ Command-line Extension │ ○ Command-line Extension
│ ○ Remote Extension │ ○ Remote Extension (SSE)
│ ○ Remote Extension (Streaming HTTP)
``` ```

View File

@@ -57,7 +57,8 @@ Note that you'll need [uv](https://docs.astral.sh/uv/#installation) installed on
// highlight-start // highlight-start
│ ● Command-line Extension (Run a local command or script) │ ● Command-line Extension (Run a local command or script)
// highlight-end // highlight-end
│ ○ Remote Extension │ ○ Remote Extension (SSE)
│ ○ Remote Extension (Streaming HTTP)
``` ```