Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions documentation/docs/getting-started/using-extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,11 @@ Here are the built-in extensions:
│ ○ Google Drive
│ ○ Memory
│ ● JetBrains
◇ Please set the timeout for this tool (in secs):
│ 300
└ Enabled jetbrains extension
```
</TabItem>
<TabItem value="ui" label="Goose Desktop">
Expand Down Expand Up @@ -143,6 +147,9 @@ See available servers in the **[MCP Server Directory](https://www.pulsemcp.com/s
◇ What command should be run?
│ npx -y @modelcontextprotocol/server-memory
◇ Please set the timeout for this tool (in secs):
│ 300
◆ Would you like to add environment variables?
│ No
Expand All @@ -154,9 +161,11 @@ See available servers in the **[MCP Server Directory](https://www.pulsemcp.com/s

1. Click `...` in the top right corner of the Goose Desktop.
2. Select `Settings` from the menu.
3. Under `Extensions`, click `Add` link.
4. On the `Add Extension Manually` modal, enter the necessary details and click `Add` button
5. Click `Add Extension` button
3. Under `Extensions`, click `Add custom extension`.
4. On the `Add custom extension` modal, enter the necessary details
- If adding an environment variable, click `Add` button to the right of the variable
- The `Timeout` field lets you set how long Goose should wait for a tool call from this extension to complete
5. Click `Add` button

#### Example of adding the [Knowledge Graph Memory MCP Server](https://github.com/modelcontextprotocol/servers/tree/main/src/memory):
* **Type**: `Standard IO`
Expand All @@ -179,6 +188,7 @@ extensions:
enabled: true
envs: { "GITHUB_PERSONAL_ACCESS_TOKEN": "<YOUR_TOKEN>" }
type: stdio
timeout: 300
```


Expand Down
10 changes: 7 additions & 3 deletions documentation/docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ While you're able to manually navigate to your working directory and open the HT
```sh
goose configure
```
3. Choose `Add extension` > `Built-in Extension` > `Computer Controller`. This [extension](https://block.github.io/goose/v1/extensions/detail/nondeveloper) enables webscraping, file caching, and automations.
3. Choose `Add extension` > `Built-in Extension` > `Computer Controller`, and set timeout to 300s. This [extension](https://block.github.io/goose/v1/extensions/detail/nondeveloper) enables webscraping, file caching, and automations.
```
┌ goose-configure
Expand All @@ -138,13 +138,17 @@ While you're able to manually navigate to your working directory and open the HT
◇ What type of extension would you like to add?
│ Built-in Extension
Which built-in extension would you like to enable?
Which built-in extension would you like to enable?
│ ○ Developer Tools
│ ● Computer Controller (controls for webscraping, file caching, and automations)
│ ○ Google Drive
│ ○ Memory
│ ○ JetBrains
◇ Please set the timeout for this tool (in secs):
│ 300
└ Enabled Computer Controller extension
```
4. Now that Goose has browser capabilities, let's resume your last session:
```sh
Expand Down
49 changes: 34 additions & 15 deletions documentation/docs/tutorials/_template_.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,31 @@ Note that you'll need [uv](https://docs.astral.sh/uv/#installation) installed on
```

5. Obtain a [GitHub Personal Access Token](https://github.com/settings/personal-access-tokens) and paste it in.
5. Enter the number of seconds Goose should wait for actions to complete before timing out. Default is 300s
```sh
┌ goose-configure
◇ What would you like to configure?
│ Add Extension
◇ What type of extension would you like to add?
│ Command-line Extension
◇ What would you like to call this extension?
│ {name}
◇ What command should be run?
│ {command}
// highlight-start
◆ Please set the timeout for this tool (in secs):
│ 300
// highlight-end
```

6. Obtain a [GitHub Personal Access Token](https://github.com/settings/personal-access-tokens) and paste it in.
:::info
When creating your access token, you can specify the repositories and granular permissions you'd like Goose to have access to.
:::
Expand All @@ -115,6 +139,10 @@ Note that you'll need [uv](https://docs.astral.sh/uv/#installation) installed on
◇ What command should be run?
│ {command}
◇ Please set the timeout for this tool (in secs):
│ 300
// highlight-start
◆ Would you like to add environment variables?
│ Yes
Expand All @@ -133,20 +161,11 @@ Note that you'll need [uv](https://docs.astral.sh/uv/#installation) installed on

</TabItem>
<TabItem value="ui" label="Goose Desktop">
1. Click `...` in the upper right corner
2. Click `Settings`
3. Under `Extensions`, click the `Add` link
4. On the `Add Extension Manually` modal, enter the following:
* **Type**: `Standard IO`
* **ID**: `{name}-mcp` (_set this to whatever you want_)
* **Name**: `{name}` (_set this to whatever you want_)
* **Description**: `{name} MCP Server` (_set this to whatever you want_)
* **Command**: `{command}`
* **Environment Variables**
* **Name**: `{env_var}`
* **Value**: (_Obtain a [{env_var}](/) and paste it in._)
* Click `Add` button
5. Click `Add Extension` button
1. [Launch the installer](goose://extension?cmd=npx&arg=-y&arg=%40hapins%2Ffigma-mcp&id=figma&name=Figma&description=Figma%20design%20tool%20integration&env=FIGMA_ACCESS_TOKEN%3DAccess%20token%20from%20Figma%20user%20settings)
2. Press `Yes` to confirm the installation
3. Obtain a [XYZ Access Token](/) and paste it in
4. Click `Save Configuration`
5. Scroll to the top and click `Exit` from the upper left corner
</TabItem>
</Tabs>

Expand Down
20 changes: 20 additions & 0 deletions documentation/docs/tutorials/computer-controller-mcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,26 @@ Let Goose complete its tasks without interruption - avoid using your mouse or ke
| ○ JetBrains
└ Enabled Computer Controller extension
```

4. Enter the number of seconds Goose should wait for actions to complete before timing out. Default is 300s
```sh
┌ goose-configure
◇ What would you like to configure?
│ Add Extension
◇ What type of extension would you like to add?
│ Built-in Extension
◆ Which built-in extension would you like to enable?
│ Computer Controller
// highlight-start
◆ Please set the timeout for this tool (in secs):
│ 300
// highlight-end
└ Enabled Computer Controller extension
```
</TabItem>
<TabItem value="ui" label="Goose Desktop">
1. Click `...` in the upper right corner
Expand Down
28 changes: 27 additions & 1 deletion documentation/docs/tutorials/fetch-mcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,30 @@ Note that you'll need [uv](https://docs.astral.sh/uv/#installation) installed on
```

5. Choose No when asked to add environment variables
5. Enter the number of seconds Goose should wait for actions to complete before timing out. Default is 300s
```sh
┌ goose-configure
◇ What would you like to configure?
│ Add Extension
◇ What type of extension would you like to add?
│ Command-line Extension
◇ What would you like to call this extension?
│ fetch
◇ What command should be run?
│ uvx mcp-server-fetch
// highlight-start
◆ Please set the timeout for this tool (in secs):
│ 300
// highlight-end
```

6. Choose No when asked to add environment variables

```sh
┌ goose-configure
Expand All @@ -108,6 +131,9 @@ Note that you'll need [uv](https://docs.astral.sh/uv/#installation) installed on
◇ What command should be run?
│ uvx mcp-server-fetch
◇ Please set the timeout for this tool (in secs):
│ 300
// highlight-start
◇ Would you like to add environment variables?
│ No
Expand Down
30 changes: 29 additions & 1 deletion documentation/docs/tutorials/figma-mcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,31 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
```

5. Obtain a [Figma Access Token](https://www.figma.com/developers/api#access-tokens) and paste it in.
5. Enter the number of seconds Goose should wait for actions to complete before timing out. Default is 300s
```sh
┌ goose-configure
◇ What would you like to configure?
│ Add Extension
◇ What type of extension would you like to add?
│ Command-line Extension
◇ What would you like to call this extension?
│ figma
◇ What command should be run?
│ npx @hapins/figma-mcp
// highlight-start
◆ Please set the timeout for this tool (in secs):
│ 300
// highlight-end
```

6. Obtain a [Figma Access Token](https://www.figma.com/developers/api#access-tokens) and paste it in.
:::info
You can generate an access token from your Figma account settings under the Personal access tokens section.
:::
Expand All @@ -111,6 +135,10 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
◇ What command should be run?
│ npx @hapins/figma-mcp
◇ Please set the timeout for this tool (in secs):
│ 300
// highlight-start
◆ Would you like to add environment variables?
│ Yes
Expand Down
30 changes: 29 additions & 1 deletion documentation/docs/tutorials/github-mcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,31 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
```

5. Obtain a [GitHub Personal Access Token](https://github.com/settings/personal-access-tokens) and paste it in.
5. Enter the number of seconds Goose should wait for actions to complete before timing out. Default is 300s
```sh
┌ goose-configure
◇ What would you like to configure?
│ Add Extension
◇ What type of extension would you like to add?
│ Command-line Extension
◇ What would you like to call this extension?
│ github
◇ What command should be run?
│ npx -y @modelcontextprotocol/server-github
// highlight-start
◆ Please set the timeout for this tool (in secs):
│ 300
// highlight-end
```

6. Obtain a [GitHub Personal Access Token](https://github.com/settings/personal-access-tokens) and paste it in.
:::info
When creating your access token, you can specify the repositories and granular permissions you'd like Goose to have access to.
:::
Expand All @@ -110,6 +134,10 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
◇ What command should be run?
│ npx -y @modelcontextprotocol/server-github
◇ Please set the timeout for this tool (in secs):
│ 300
// highlight-start
◆ Would you like to add environment variables?
│ Yes
Expand Down
31 changes: 30 additions & 1 deletion documentation/docs/tutorials/google-drive-mcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,10 +145,35 @@ You'll need to re-authenticate once a day when using the Google Drive extension.
```

5. Enter the number of seconds Goose should wait for actions to complete before timing out. Default is 300s
```sh
┌ goose-configure
◇ What would you like to configure?
│ Add Extension
◇ What type of extension would you like to add?
│ Command-line Extension
◇ What would you like to call this extension?
│ google drive
◇ What command should be run?
│ npx -y @modelcontextprotocol/server-gdrive
// highlight-start
◆ Please set the timeout for this tool (in secs):
│ 300
// highlight-end
```


:::tip
You may need to use absolute paths (rather than relying on shell exapansion for `~`) for the `GDRIVE_CREDENTIALS_PATH` and `GDRIVE_OAUTH_PATH`.
:::
5. Add your environment variables

6. Add your environment variables

```sh
┌ goose-configure
Expand All @@ -164,6 +189,10 @@ You may need to use absolute paths (rather than relying on shell exapansion for
◇ What command should be run?
│ npx -y @modelcontextprotocol/server-gdrive
◇ Please set the timeout for this tool (in secs):
│ 300
// highlight-start
◆ Would you like to add environment variables?
│ Yes
Expand Down
32 changes: 30 additions & 2 deletions documentation/docs/tutorials/google-maps-mcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,9 +88,33 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
│ npx -y @modelcontextprotocol/server-google-maps
// highlight-end
```
```

5. Obtain a [Google Maps API Key](https://developers.google.com/maps/documentation/javascript/get-api-key) and paste it in.
5. Enter the number of seconds Goose should wait for actions to complete before timing out. Default is 300s
```sh
┌ goose-configure
◇ What would you like to configure?
│ Add Extension
◇ What type of extension would you like to add?
│ Command-line Extension
◇ What would you like to call this extension?
│ Google Maps
◇ What command should be run?
│ npx -y @modelcontextprotocol/server-google-maps
// highlight-start
◆ Please set the timeout for this tool (in secs):
│ 300
// highlight-end
```


6. Obtain a [Google Maps API Key](https://developers.google.com/maps/documentation/javascript/get-api-key) and paste it in.

```sh
┌ goose-configure
Expand All @@ -106,6 +130,10 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
◇ What command should be run?
│ npx -y @modelcontextprotocol/server-google-maps
◇ Please set the timeout for this tool (in secs):
│ 300
// highlight-start
◆ Would you like to add environment variables?
│ Yes
Expand Down
Loading