Skip to content

Commit 47331ca

Browse files
docs: reduce bloat in web-search.md guide (#2460)
1 parent c2efd4e commit 47331ca

File tree

1 file changed

+11
-32
lines changed

1 file changed

+11
-32
lines changed

docs/src/content/docs/guides/web-search.md

Lines changed: 11 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,11 @@ sidebar:
55
order: 210
66
---
77

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.
159

1610
## Tavily Search
1711

18-
[Tavily](https://tavily.com/) provides AI-optimized search designed for LLM applications with structured results.
19-
20-
**MCP Server:** [@tavily/mcp-server](https://github.com/tavily-ai/tavily-mcp-server)
12+
[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.
2113

2214
```aw
2315
---
@@ -39,12 +31,6 @@ Search the web for information about: ${{ github.event.issue.title }}
3931
Use the tavily search tool to find recent information.
4032
```
4133

42-
**Features:**
43-
- AI-optimized search results
44-
- News search capability
45-
- Structured JSON responses
46-
- Fast response times
47-
4834
**Setup:**
4935
1. Sign up at [tavily.com](https://tavily.com/)
5036
2. Get your API key from the dashboard
@@ -54,23 +40,19 @@ Use the tavily search tool to find recent information.
5440

5541
## MCP Server Configuration
5642

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:
5844

5945
```yaml
6046
mcp-servers:
6147
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"]
6450
env:
6551
TAVILY_API_KEY: "${{ secrets.TAVILY_API_KEY }}"
66-
allowed: ["search", "search_news"] # Specific tools to allow
52+
allowed: ["search", "search_news"]
6753
```
6854
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>`.
7456

7557
## Tool Discovery
7658

@@ -86,27 +68,24 @@ gh aw mcp list-tools tavily my-workflow --verbose
8668

8769
## Network Permissions
8870

89-
Some engines (like Claude) require explicit network permissions for MCP servers to access external APIs:
71+
Engines like Claude require explicit network permissions for MCP servers:
9072

9173
```yaml
9274
engine: claude
9375
network:
9476
allowed:
95-
- defaults # Basic infrastructure
96-
- "*.tavily.com" # Tavily API
77+
- defaults
78+
- "*.tavily.com"
9779
```
9880

99-
The Copilot engine doesn't require explicit network permissions as MCP servers run with network access by default.
81+
The Copilot engine doesn't require this configuration.
10082

10183
## Related Documentation
10284

10385
- [MCP Integration](/gh-aw/guides/mcps/) - Complete MCP server guide
10486
- [Tools](/gh-aw/reference/tools/) - Tool configuration reference
10587
- [AI Engines](/gh-aw/reference/engines/) - Engine capabilities and limitations
10688
- [CLI Commands](/gh-aw/tools/cli/) - CLI commands including `mcp inspect`
107-
108-
## External Resources
109-
11089
- [Model Context Protocol Specification](https://github.com/modelcontextprotocol/specification)
11190
- [Tavily MCP Server](https://github.com/tavily-ai/tavily-mcp-server)
11291
- [Tavily Documentation](https://tavily.com/)

0 commit comments

Comments
 (0)