added Description prompt to tutorials (#2392)

This commit is contained in:
w. ian douglas
2025-04-29 12:48:41 -06:00
committed by GitHub
parent 72baf5933b
commit a1ab95cbed
24 changed files with 633 additions and 30 deletions

View File

@@ -119,7 +119,34 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
```
6. Obtain an [AgentQL API Key](https://dev.agentql.com/api-keys) and paste it in.
6. Choose to add a description. If you select "Yes" here, you will be prompted to enter a description for the extension.
```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?
│ agentql
◇ What command should be run?
│ npx -y agentql-mcp
◆ Please set the timeout for this tool (in secs):
│ 300
// highlight-start
◇ Would you like to add a description?
│ No
// highlight-end
```
7. Obtain an [AgentQL API Key](https://dev.agentql.com/api-keys) and paste it in.
```sh
┌ goose-configure
@@ -139,6 +166,9 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
◇ 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?
│ Yes

View File

@@ -126,8 +126,35 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
```
6. Choose to add a description. If you select "Yes" here, you will be prompted to enter a description for the extension.
```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?
│ Asana
◇ What command should be run?
│ npx -y @roychri/mcp-server-asana
◇ Please set the timeout for this tool (in secs):
│ 300
// highlight-start
◇ Would you like to add a description?
│ No
// highlight-end
```
6. Obtain a [Asana Access Token](https://app.asana.com/0/my-apps) and paste it in.
7. Obtain a [Asana Access Token](https://app.asana.com/0/my-apps) and paste it in.
:::info
See [Asana's developer docs](https://developers.asana.com/docs/personal-access-token) if you need detailed instructions on creating an access token.
:::
@@ -149,6 +176,9 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
◇ 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?

View File

@@ -134,8 +134,35 @@ Note that you'll need [uv](https://docs.astral.sh/uv/#installation) installed on
```
6. Choose to add a description. If you select "Yes" here, you will be prompted to enter a description for the extension.
```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?
│ blender
◇ What command should be run?
│ uvx blender-mcp
◇ Please set the timeout for this tool (in secs):
│ 300
// highlight-start
◇ Would you like to add a description?
│ No
// highlight-end
```
6. Choose No when asked to add environment variables
7. Choose No when asked to add environment variables
```sh
┌ goose-configure
@@ -154,6 +181,9 @@ Note that you'll need [uv](https://docs.astral.sh/uv/#installation) installed on
◇ 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?

View File

@@ -5,7 +5,9 @@ description: Add Brave Search API as a Goose Extension
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import YouTubeShortEmbed from '@site/src/components/YouTubeShortEmbed';
<YouTubeShortEmbed videoUrl="https://www.youtube.com/embed/kD2YA61NTLU" />
This tutorial will get you started with the [Brave Search MCP Server](https://github.com/modelcontextprotocol/servers/tree/main/src/brave-search) as a Goose extension to enable interactive searches for both web and local searches.

View File

@@ -120,7 +120,8 @@ Note that you'll need [uv](https://docs.astral.sh/uv/#installation) installed on
// highlight-end
```
```
6. Choose to add a description. If you select "Yes" here, you will be prompted to enter a description for the extension.
```sh
┌ goose-configure

View File

@@ -118,7 +118,33 @@ Note that you'll need [uv](https://docs.astral.sh/uv/#installation) installed on
```
6. Choose No when asked to add environment variables
6. Choose to add a description. If you select "Yes" here, you will be prompted to enter a description for the extension.
```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
◇ Please set the timeout for this tool (in secs):
│ 300
// highlight-start
◇ Would you like to add a description?
│ No
// highlight-end
```
7. Choose No when asked to add environment variables
```sh
┌ goose-configure
@@ -137,6 +163,9 @@ Note that you'll need [uv](https://docs.astral.sh/uv/#installation) installed on
◇ 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?

View File

@@ -123,7 +123,33 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
```
6. Obtain a [Figma Access Token](https://www.figma.com/developers/api#access-tokens) and paste it in.
6. Choose to add a description. If you select "Yes" here, you will be prompted to enter a description for the extension.
```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
◇ Please set the timeout for this tool (in secs):
│ 300
// highlight-start
◇ Would you like to add a description?
│ No
// highlight-end
```
7. 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.
:::
@@ -146,6 +172,9 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
◇ 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?
│ Yes

View File

@@ -130,7 +130,7 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
```
6. Choose No when asked to add environment variables
6. Choose to add a description. If you select "Yes" here, you will be prompted to enter a description for the extension.
```sh
┌ goose-configure
@@ -148,6 +148,35 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
◇ Please set the timeout for this tool (in secs):
│ 300
// highlight-start
◆ Would you like to add a description?
│ No
// highlight-end
```
7. Choose No when asked to add environment variables
```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?
│ filesystem
◇ What command should be run?
│ npx -y @modelcontextprotocol/server-filesystem /path/to/allowed/directory
◇ 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?

View File

@@ -122,7 +122,34 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
```
6. Obtain a [GitHub Personal Access Token](https://github.com/settings/personal-access-tokens) and paste it in.
6. Choose to add a description. If you select "Yes" here, you will be prompted to enter a description for the extension.
```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
◆ Please set the timeout for this tool (in secs):
│ 300
// highlight-start
◇ Would you like to add a description?
│ No
// highlight-end
```
7. 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.
:::
@@ -144,7 +171,10 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
◇ 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?
│ Yes

View File

@@ -182,12 +182,33 @@ You'll need to re-authenticate once a day when using the Google Drive extension.
```
6. Choose to add a description. If you select "Yes" here, you will be prompted to enter a description for the extension.
```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
◇ Please set the timeout for this tool (in secs):
│ 300
// highlight-start
◇ Would you like to add a description?
│ No
// 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`.
:::
6. Add your environment variables
7. Add your environment variables
```sh
┌ goose-configure
@@ -206,6 +227,9 @@ You may need to use absolute paths (rather than relying on shell exapansion for
◇ 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?

View File

@@ -119,9 +119,35 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
// highlight-end
```
6. Obtain a [Google Maps API Key](https://developers.google.com/maps/documentation/javascript/get-api-key) and paste it in.
6. Choose to add a description. If you select "Yes" here, you will be prompted to enter a description for the extension.
```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
◆ Please set the timeout for this tool (in secs):
│ 300
// highlight-start
◇ Would you like to add a description?
│ No
// highlight-end
```
7. Obtain a [Google Maps API Key](https://developers.google.com/maps/documentation/javascript/get-api-key) and paste it in.
```sh
┌ goose-configure
@@ -140,6 +166,9 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
◇ 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?

View File

@@ -90,6 +90,30 @@ This tutorial covers how to enable and use the JetBrains MCP Server as a built-i
└ Enabled jetbrains extension
```
5. Choose to add a description. If you select "Yes" here, you will be prompted to enter a description for the extension.
```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?
│ JetBrains
◇ Please set the timeout for this tool (in secs):
│ 300
// highlight-start
◆ Would you like to add a description?
│ No
// highlight-end
```
</TabItem>
</Tabs>

View File

@@ -114,7 +114,34 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
```
6. Choose No when asked to add environment variables
6. Choose to add a description. If you select "Yes" here, you will be prompted to enter a description for the extension.
```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?
│ knowledge graph memory
◇ What command should be run?
│ npx -y @modelcontextprotocol/server-memory
◆ Please set the timeout for this tool (in secs):
│ 300
// highlight-start
◇ Would you like to add a description?
│ No
// highlight-end
```
7. Choose No when asked to add environment variables
```sh
┌ goose-configure
@@ -132,6 +159,9 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
◇ 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?

View File

@@ -87,6 +87,29 @@ This tutorial covers enabling and using the Memory MCP Server, which is a built-
// highlight-end
└ Enabled Memory extension
```
5. Choose to add a description. If you select "Yes" here, you will be prompted to enter a description for the extension.
```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?
│ Memory
◇ Please set the timeout for this tool (in secs):
│ 300
// highlight-start
◆ Would you like to add a description?
│ No
// highlight-end
└ Enabled Memory extension
```
</TabItem>
</Tabs>

View File

@@ -121,7 +121,34 @@ Note that you'll need [uv](https://docs.astral.sh/uv/#installation) installed on
```
6. Choose No when asked to add environment variables
6. Choose to add a description. If you select "Yes" here, you will be prompted to enter a description for the extension.
```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?
│ pdf
◇ What command should be run?
│ uvx mcp-read-pdf
◇ Please set the timeout for this tool (in secs):
│ 300
// highlight-start
◇ Would you like to add a description?
│ No
// highlight-end
```
7. Choose No when asked to add environment variables
```sh
┌ goose-configure
@@ -141,6 +168,9 @@ Note that you'll need [uv](https://docs.astral.sh/uv/#installation) installed on
◇ 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

View File

@@ -143,10 +143,12 @@ http://localhost:39300/model_context_protocol/2024-11-05/sse
◇ Please set the timeout for this tool (in secs):
│ 300
// highlight-start
◆ Would you like to add a description?
│ ○ Yes / ● No
// highlight-end
```
@@ -169,6 +171,7 @@ http://localhost:39300/model_context_protocol/2024-11-05/sse
◇ Please set the timeout for this tool (in secs):
│ 300
◇ Would you like to add a description?
│ No

View File

@@ -134,7 +134,30 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
```
6. Configure your PostgreSQL connection URL
6. Choose to add a description. If you select "Yes" here, you will be prompted to enter a description for the extension.
```sh
┌ goose-configure
◇ What would you like to configure?
│ Add Extension
◇ What would you like to call this extension?
│ PostgreSQL
◇ What command should be run?
│ npx -y @modelcontextprotocol/server-postgres postgresql://localhost/mydb
◇ Please set the timeout for this tool (in secs):
│ 300
// highlight-start
◆ Would you like to add a description?
│ No
// highlight-end
```
7. Configure your PostgreSQL connection URL
```sh
┌ goose-configure
@@ -149,6 +172,9 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
◇ 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?

View File

@@ -114,7 +114,33 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
```
6. Choose No when asked to add environment variables
6. Choose to add a description. If you select "Yes" here, you will be prompted to enter a description for the extension.
```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?
│ Puppeteer
◇ What command should be run?
│ npx -y @modelcontextprotocol/server-puppeteer
◇ Please set the timeout for this tool (in secs):
│ 300
// highlight-start
◇ Would you like to add a description?
│ No
// highlight-end
```
7. Choose No when asked to add environment variables
```sh
┌ goose-configure
@@ -133,6 +159,9 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
◇ 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?

View File

@@ -117,8 +117,35 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
```
6. Choose to add a description. If you select "Yes" here, you will be prompted to enter a description for the extension.
```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?
│ repomix
◇ What command should be run?
│ npx -y repomix --mcp
◇ Please set the timeout for this tool (in secs):
│ 300
// highlight-start
◇ Would you like to add a description?
│ No
// highlight-end
```
6. Choose No when asked to add environment variables
7. Choose No when asked to add environment variables
```sh
┌ goose-configure
@@ -137,6 +164,9 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
◇ 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?

View File

@@ -117,8 +117,35 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
```
6. Choose to add a description. If you select "Yes" here, you will be prompted to enter a description for the extension.
```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?
│ Selenium
◇ What command should be run?
│ npx -y @angiejones/mcp-selenium
◇ Please set the timeout for this tool (in secs):
│ 300
// highlight-start
◇ Would you like to add a description?
│ No
// highlight-end
```
6. Choose No when asked to add environment variables
7. Choose No when asked to add environment variables
```sh
┌ goose-configure
@@ -137,6 +164,9 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
◇ 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?

View File

@@ -120,7 +120,8 @@ Before adding this extension, make sure [PortAudio](https://github.com/GoogleClo
// highlight-end
```
6. Choose No when asked to add environment variables
6. Choose to add a description. If you select "Yes" here, you will be prompted to enter a description for the extension.
```sh
┌ goose-configure
@@ -140,6 +141,35 @@ Before adding this extension, make sure [PortAudio](https://github.com/GoogleClo
│ 300
// highlight-start
◇ Would you like to add a description?
│ No
// highlight-end
```
7. Choose No when asked to add environment variables
```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?
│ speech
◇ What command should be run?
│ uvx -p 3.10.14 speech-mcp@latest
◇ 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

View File

@@ -120,7 +120,33 @@ Note that you'll need [uv](https://docs.astral.sh/uv/#installation) installed on
```
6. Obtain a [Tavily API Key](https://tavily.com/) and paste it in.
6. Choose to add a description. If you select "Yes" here, you will be prompted to enter a description for the extension.
```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?
│ tavily
◇ What command should be run?
│ npx -y tavily-mcp
◇ Please set the timeout for this tool (in secs):
│ 300
// highlight-start
◇ Would you like to add a description?
│ No
// highlight-end
```
7. Obtain a [Tavily API Key](https://tavily.com/) and paste it in.
:::info
You can get your API key by signing up at [tavily.com](https://app.tavily.com/) and navigating to your account settings.
:::
@@ -143,6 +169,9 @@ Note that you'll need [uv](https://docs.astral.sh/uv/#installation) installed on
◇ 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?
│ Yes

View File

@@ -121,8 +121,35 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
```
6. Choose to add a description. If you select "Yes" here, you will be prompted to enter a description for the extension.
```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?
│ vscode-mcp
◇ What command should be run?
│ npx vscode-mcp-server install
◆ Please set the timeout for this tool (in secs):
│ 300
// highlight-start
◇ Would you like to add a description?
│ No
// highlight-end
```
6. No additional environment variables are required for basic setup
7. No additional environment variables are required for basic setup
</TabItem>
</Tabs>

View File

@@ -116,8 +116,35 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
```
6. No environment variables are required for this extension
6. Choose to add a description. If you select "Yes" here, you will be prompted to enter a description for the extension.
```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?
│ knowledge graph memory
◇ What command should be run?
│ npx -y @modelcontextprotocol/server-memory
◆ Please set the timeout for this tool (in secs):
│ 300
// highlight-start
◇ Would you like to add a description?
│ No
// highlight-end
```
7. No environment variables are required for this extension
```sh
┌ goose-configure
@@ -132,11 +159,13 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
◇ What command should be run?
│ npx @jkawamoto/mcp-youtube-transcript
◇ Please set the timeout for this tool (in secs):
│ 300
// highlight-start
◇ Would you like to add a description?
│ No // highlight-start
◆ Would you like to add environment variables?
│ No
// highlight-end