You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/src/content/docs/guides/web-search.md
+11-32Lines changed: 11 additions & 32 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,19 +5,11 @@ sidebar:
5
5
order: 210
6
6
---
7
7
8
-
This guide covers how to add web search capabilities to workflows using the Tavily MCP server.
9
-
10
-
## Overview
11
-
12
-
Some AI engines (like Copilot) don't include built-in web search functionality. To add web search capabilities to these workflows, you can integrate third-party MCP servers that provide search functionality.
13
-
14
-
This guide focuses on Tavily, an AI-optimized search provider designed for LLM applications. Other alternatives include Exa (semantic search), SerpAPI (Google search access), and Brave Search (privacy-focused), though this guide only covers Tavily setup.
8
+
This guide shows how to add web search to workflows using the Tavily MCP server, an AI-optimized search provider designed for LLM applications. While alternatives exist (Exa, SerpAPI, Brave Search), this guide focuses on Tavily configuration.
15
9
16
10
## Tavily Search
17
11
18
-
[Tavily](https://tavily.com/) provides AI-optimized search designed for LLM applications with structured results.
[Tavily](https://tavily.com/) provides AI-optimized search with structured JSON responses, news search capability, and fast response times through the [@tavily/mcp-server](https://github.com/tavily-ai/tavily-mcp-server) MCP server.
21
13
22
14
```aw
23
15
---
@@ -39,12 +31,6 @@ Search the web for information about: ${{ github.event.issue.title }}
39
31
Use the tavily search tool to find recent information.
40
32
```
41
33
42
-
**Features:**
43
-
- AI-optimized search results
44
-
- News search capability
45
-
- Structured JSON responses
46
-
- Fast response times
47
-
48
34
**Setup:**
49
35
1. Sign up at [tavily.com](https://tavily.com/)
50
36
2. Get your API key from the dashboard
@@ -54,23 +40,19 @@ Use the tavily search tool to find recent information.
54
40
55
41
## MCP Server Configuration
56
42
57
-
Tavily MCP server follows this basic pattern:
43
+
Configure the Tavily MCP server with the `allowed` list to restrict tools, store API keys in GitHub Secrets (never commit them), and use the `-y` flag with npx for automatic installation:
58
44
59
45
```yaml
60
46
mcp-servers:
61
47
tavily:
62
-
command: npx# Use npx for npm packages
63
-
args: ["-y", "@tavily/mcp-server"]# -y to auto-install
48
+
command: npx
49
+
args: ["-y", "@tavily/mcp-server"]
64
50
env:
65
51
TAVILY_API_KEY: "${{ secrets.TAVILY_API_KEY }}"
66
-
allowed: ["search", "search_news"]# Specific tools to allow
52
+
allowed: ["search", "search_news"]
67
53
```
68
54
69
-
**Best Practices:**
70
-
1. Always use the `allowed` list to restrict which tools can be used
71
-
2. Store API keys in GitHub Secrets, never commit them
72
-
3. Use `-y` flag with npx to ensure automatic installation
73
-
4. Test MCP configuration with `gh aw mcp inspect <workflow-name>`
55
+
Test your configuration with `gh aw mcp inspect <workflow-name>`.
0 commit comments