docs: description required for "Add Extension" in cli (#5573)

This commit is contained in:
dianed-square
2025-11-05 08:09:35 -08:00
committed by GitHub
parent 78fd31a47a
commit efdf22eacd
18 changed files with 281 additions and 224 deletions
+52 -45
View File
@@ -7,7 +7,6 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import CLIExtensionInstructions from '@site/src/components/CLIExtensionInstructions';
import GooseDesktopInstaller from '@site/src/components/GooseDesktopInstaller';
import { PanelLeft } from 'lucide-react';
This tutorial covers how to add the [Apify MCP server](https://mcp.apify.com) as a goose extension, enabling goose to call thousands of tools from [Apify Store](https://apify.com/store) to extract data from social media, e-commerce sites, search engines, online maps, or any other website.
@@ -20,50 +19,56 @@ This tutorial covers how to add the [Apify MCP server](https://mcp.apify.com) as
:::tip TLDR
<Tabs groupId="interface">
<TabItem value="ui" label="goose Desktop" default>
Use `Add custom extension` in Settings → Extensions to add a `Streamable HTTP` extension type with:
[Launch the installer](goose://extension?type=streamable_http&url=https%3A%2F%2Fmcp.apify.com&id=apify&name=Apify&description=Extract%20data%20from%20any%20website%20with%20thousands%20of%20scrapers%2C%20crawlers%2C%20and%20automations%20on%20Apify%20Store&header=Authorization%3DBearer%20YOUR_APIFY_TOKEN)
</TabItem>
<TabItem value="cli" label="goose CLI">
Use `goose configure` to add a `Remote Extension (Streaming HTTP)` extension type with:
Add a `Remote Extension (Streaming HTTP)` extension type with:
**Endpoint URL**
```
https://mcp.apify.com
```
</TabItem>
</Tabs>
**Endpoint URL**
```
https://mcp.apify.com
```
**Custom Request Header**
```
Authorization: Bearer <YOUR_APIFY_TOKEN>
```
:::
<Tabs groupId="interface">
<TabItem value="ui" label="goose Desktop" default>
1. Obtain an [Apify Token](https://console.apify.com/settings/integrations)
2. Click the <PanelLeft className="inline" size={16} /> button in the top-left to open the sidebar
3. Click `Extensions`
4. Click `Add custom extension`
5. On the `Add custom extension` modal, enter the following:
- **Extension Name**: Apify
- **Type**: Streamable HTTP
- **Endpoint**: `https://mcp.apify.com`
- **Request Headers**:
- **Header name**: `Authorization`
- **Value**: `Bearer <YOUR_APIFY_TOKEN>`
6. Click `+ Add` to save the header
7. Click `Add Extension` to save the extension
9. Navigate to the chat
<GooseDesktopInstaller
extensionId="apify"
extensionName="Apify"
description="Extract data from any website with thousands of scrapers, crawlers, and automations on Apify Store"
type="http"
url="https://mcp.apify.com"
envVars={[
{ name: "Authorization", label: "Bearer YOUR_APIFY_TOKEN" }
]}
apiKeyLink="https://console.apify.com/settings/integrations"
apiKeyLinkText="Apify Token"
/>
</TabItem>
<TabItem value="cli" label="goose CLI">
<CLIExtensionInstructions
name="apify-mcp"
name="Apify"
description="Extract data from any website with thousands of scrapers, crawlers, and automations on Apify Store"
type="http"
url="https://mcp.apify.com"
timeout={300}
envVars={[
{ key: "Authorization", value: "Bearer apify_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" }
]}
infoNote={
<>
Obtain your <a href="https://console.apify.com/settings/integrations" target="_blank" rel="noopener noreferrer">Apify Token</a> and paste it in as the <code>Bearer</code> token.
</>
}
/>
:::info
Obtain your <a href="https://console.apify.com/settings/integrations" target="_blank" rel="noopener noreferrer">Apify Token</a> and paste it in.
:::
</TabItem>
</Tabs>
@@ -94,35 +99,37 @@ APIFY_TOKEN: <YOUR_APIFY_TOKEN>
<Tabs groupId="interface">
<TabItem value="ui" label="goose Desktop" default>
1. Obtain an [Apify Token](https://console.apify.com/settings/integrations)
2. Click the <PanelLeft className="inline" size={16} /> button in the top-left to open the sidebar
3. Click `Extensions`
4. Click `Add custom extension`
5. On the `Add custom extension` modal, enter the following:
- **Extension Name**: Apify
- **Type**: STDIO
- **Command**: `npx -y @apify/actors-mcp-server`
- **Environment Variables**:
- **Variable name**: `APIFY_TOKEN`
- **Value**: `<YOUR_APIFY_TOKEN>`
6. Click `+ Add` to save the header
7. Click `Add Extension` to save the extension
9. Navigate to the chat
<GooseDesktopInstaller
extensionId="mcp_apify_local"
extensionName="Apify Local MCP Server"
description="Extract data from any website with thousands of scrapers, crawlers, and automations on Apify Store"
type="stdio"
command="npx"
args={["-y", "@apify/actors-mcp-server"]}
envVars={[
{ name: "APIFY_TOKEN", label: "<YOUR_APIFY_TOKEN>" }
]}
apiKeyLink="https://console.apify.com/settings/integrations"
apiKeyLinkText="Apify Token"
/>
</TabItem>
<TabItem value="cli" label="goose CLI">
<CLIExtensionInstructions
name="apify-mcp"
name="Apify Local MCP Server"
description="Extract data from any website with thousands of scrapers, crawlers, and automations on Apify Store"
type="stdio"
command="npx -y @apify/actors-mcp-server"
timeout={300}
envVars={[
{ key: "APIFY_TOKEN", value: "apify_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" }
]}
infoNote={
<>
Obtain your <a href="https://console.apify.com/settings/integrations" target="_blank" rel="noopener noreferrer">Apify Token</a> and paste it in.
</>
}
/>
:::info
Obtain your <a href="https://console.apify.com/settings/integrations" target="_blank" rel="noopener noreferrer">Apify Token</a> and paste it in.
:::
</TabItem>
</Tabs>
@@ -135,7 +142,7 @@ The Apify MCP server lets you connect goose to [Apify Store](https://apify.com/s
In this example, goose will use the [Google Places Scraper](https://apify.com/compass/crawler-google-places) Actor to identify the most credible, top-rated Italian restaurant in Prague based on public ratings, reviews, and fine-dining recognition.
### Goose Prompt
### goose Prompt
```
@@ -143,7 +150,7 @@ In this example, goose will use the [Google Places Scraper](https://apify.com/co
```
### Goose Output
### goose Output
```