tkmind/tkmind_go
1
0
Fork 0
Code Issues Pull Requests Actions 4 Packages Projects Releases Wiki Activity

docs: description required for "Add Extension" in cli - phase 2 (#5635)

Browse Source
This commit is contained in:
dianed-square
2025-11-07 13:27:57 -08:00
committed by GitHub
parent 4b0bef18ae
commit 65b4b2bb18
32 changed files with 608 additions and 3865 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/docs/mcp/tavily-mcp.md
+19 -155
View File
@@ -1,16 +1,17 @@
---
title: Tavily Web Search Extension
description: Add Tavily MCP Server as a Goose Extension
description: Add Tavily MCP Server as a goose Extension
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import YouTubeShortEmbed from '@site/src/components/YouTubeShortEmbed';
import GooseDesktopInstaller from '@site/src/components/GooseDesktopInstaller';
import CLIExtensionInstructions from '@site/src/components/CLIExtensionInstructions';
<YouTubeShortEmbed videoUrl="https://youtube.com/embed/mxS2G9afGxE" />
This tutorial covers how to add the [Tavily Web Search MCP Server](https://github.com/tavily-ai/tavily-mcp) as a Goose extension to enable AI-powered web search functionality.
This tutorial covers how to add the [Tavily Web Search MCP Server](https://github.com/tavily-ai/tavily-mcp) as a goose extension to enable AI-powered web search functionality.
:::tip TLDR
<Tabs groupId="interface">
@@ -52,175 +53,38 @@ Note that you'll need [uv](https://docs.astral.sh/uv/#installation) installed on
/>
</TabItem>
<TabItem value="cli" label="goose CLI">
1. Run the `configure` command:
```sh
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
// highlight-start
│ ● Command-line Extension (Run a local command or script)
// highlight-end
│ ○ Remote Extension (SSE)
│ ○ 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?
│ Command-line Extension
│
// highlight-start
◆ What would you like to call this extension?
│ tavily
// highlight-end
└
```
4. Enter the command
```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?
│ Command-line Extension
│
◇ What would you like to call this extension?
│ tavily
│
// highlight-start
◆ What command should be run?
│ npx -y tavily-mcp
// highlight-end
└
```
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 (Connect to a new 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
│
// highlight-start
◆ Please set the timeout for this tool (in secs):
│ 300
// 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
│
◇ What would you like to configure?
│ Add Extension (Connect to a new 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.
:::
```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?
│ 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
│
◇ Would you like to add a description?
│ No
│
// highlight-start
◆ Would you like to add environment variables?
│ Yes
│
◇ Environment variable name:
│ TAVILY_API_KEY
│
◇ Environment variable value:
│ ▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪
│
◇ Add another environment variable?
│ No
// highlight-end
└ Added tavily extension
```
<CLIExtensionInstructions
name="Tavily Web Search"
description="Search the web with Tavily MCP"
command="npx -y tavily-mcp"
envVars={[
{ key: "TAVILY_API_KEY", value: "▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪" }
]}
infoNote={
<>
Obtain your <a href="https://tavily.com/" target="_blank" rel="noopener noreferrer">Tavily API Key</a> and paste it in. You can get your API key by signing up at <a href="https://app.tavily.com/" target="_blank" rel="noopener noreferrer">tavily.com</a> and navigating to your account settings.
</>
}
/>
</TabItem>
</Tabs>
## Example Usage
The Tavily MCP server enables AI-powered web search functionality in your Goose interactions. When you obtain your API key, you'll have access to Tavily's advanced search capabilities including:
The Tavily MCP server enables AI-powered web search functionality in your goose interactions. When you obtain your API key, you'll have access to Tavily's advanced search capabilities including:
1. Real-time web search
2. Structured data extraction
3. Content analysis
4. Topic-specific search
### Goose Prompt
### goose Prompt
```
Search for recent news about artificial intelligence breakthroughs in medicine and summarize the key findings.
```
### Goose Output
### goose Output
```
I'll use the Tavily news search tool to find recent news about AI breakthroughs in medicine.