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
6 changes: 3 additions & 3 deletions documentation/docs/mcp/_template_.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ This tutorial covers how to add the [{Extension Name} MCP Server](/) as a goose
args={["-y", "@package/name"]}
timeout={300}
envVars={[
{ name: "API_KEY", label: "••••••••••••••••" }
{ name: "API_KEY", label: "Description or placeholder value" }
]}
apiKeyLink="https://example.com/api-keys"
apiKeyLinkText="Service Access Token"
Expand Down Expand Up @@ -87,7 +87,7 @@ This tutorial covers how to add the [{Extension Name} MCP Server](/) as a goose
command="{full command with args}"
timeout={300}
envVars={[
{ key: "API_KEY", value: "••••••••••••••••" }
{ key: "API_KEY", value: "▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪" }
]}
infoNote={
<>
Expand All @@ -107,7 +107,7 @@ This tutorial covers how to add the [{Extension Name} MCP Server](/) as a goose
url="https://example-server.com/endpoint"
timeout={300}
envVars={[ // also used for http request headers
{ key: "API_KEY", value: "••••••••••••••••" }
{ key: "API_KEY", value: "▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪" }
]}
infoNote={
<>
Expand Down
169 changes: 18 additions & 151 deletions documentation/docs/mcp/agentql-mcp.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
---
title: AgentQL Extension
description: Add AgentQL MCP Server as a Goose Extension
description: Add AgentQL MCP Server as a goose Extension
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import GooseDesktopInstaller from '@site/src/components/GooseDesktopInstaller';
import CLIExtensionInstructions from '@site/src/components/CLIExtensionInstructions';

<!-- <YouTubeShortEmbed videoUrl="https://www.youtube.com/embed/VIDEO_ID" /> -->

This tutorial covers how to add the [AgentQL MCP Server](https://github.com/tinyfish-io/agentql-mcp) as a Goose extension to extract and transform unstructured web content into structured data.
This tutorial covers how to add the [AgentQL MCP Server](https://github.com/tinyfish-io/agentql-mcp) as a goose extension to extract and transform unstructured web content into structured data.

:::tip TLDR

Expand Down Expand Up @@ -52,153 +53,19 @@ Note that you'll need [Node.js](https://nodejs.org/) installed on your system to
/>
</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?
│ agentql
// 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?
│ agentql
// highlight-start
◆ What command should be run?
│ npx -y agentql-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?
│ agentql
◇ What command should be run?
│ npx -y agentql-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?
│ 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
◇ 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?
│ agentql
◇ What command should be run?
│ npx -y agentql-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:
│ AGENTQL_API_KEY
◇ Environment variable value:
│ ▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪
◇ Add another environment variable?
│ No
// highlight-end
└ Added agentql extension
```
<CLIExtensionInstructions
name="agentql"
description="Transform unstructured web content into structured data"
command="npx -y agentql-mcp"
envVars={[
{ key: "AGENTQL_API_KEY", value: "▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪" }
]}
infoNote={
<>
Obtain your <a href="https://dev.agentql.com/api-keys" target="_blank" rel="noopener noreferrer">AgentQL API Key</a> and paste it in.
</>
}
/>

</TabItem>
</Tabs>
Expand All @@ -211,7 +78,7 @@ Let's use the AgentQL extension to gather and structure tech conference data to
Anthropic's Claude 4 Sonnet was used for this task.
:::

### Goose Prompt
### goose Prompt

```
I'm a tech conference speaker planning my 2025-2026 submissions.
Expand All @@ -230,7 +97,7 @@ To identify:
Structure results as JSON
```

### Goose Output
### goose Output

```
I'll help you analyze conference patterns using the web data extraction tool. Let me break this down into a few queries to get comprehensive data.
Expand Down
Loading
Loading