Skip to content

[docs] docs: unbloat web search guide #46940

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pelikhan merged 1 commit into from
Jul 21, 2026
Merged

[docs] docs: unbloat web search guide #46940

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 10 additions & 8 deletions docs/src/content/docs/reference/web-search.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ sidebar:
order: 15
---

This guide shows how to add web search to workflows using the Tavily Model Context Protocol (MCP) server, an AI-optimized search provider designed for LLM applications. While alternatives exist (Exa, SerpAPI, Brave Search), this guide focuses on Tavily configuration.
Use the Tavily Model Context Protocol (MCP) server to add web search to workflows. Alternatives such as Exa, SerpAPI, and Brave Search also exist, but this page covers Tavily.

## Tavily Search

[Tavily](https://tavily.com/) provides AI-optimized search with structured JSON responses, news search capability, and fast response times through the [@tavily/mcp](https://github.com/tavily-ai/tavily-mcp) MCP server.
[Tavily](https://tavily.com/) provides structured JSON search results, news search, and an MCP server at [@tavily/mcp](https://github.com/tavily-ai/tavily-mcp).

```aw wrap
---
Expand All @@ -33,17 +33,19 @@ Search the web for information about: ${{ github.event.issue.title }}
Use the tavily search tool to find recent information.
```

**Setup:**
1. Sign up at [tavily.com](https://tavily.com/) and get your API key
2. Add as repository secret: `gh aw secrets set TAVILY_API_KEY --value "<your-api-key>"`
### Setup

@github-actions github-actions Bot Jul 21, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Misleading coupling: linking ToS review and testing with "then" implies one must precede the other — readers who defer the ToS review may skip testing entirely.

💡 Suggested fix

Separate the two actions so they read as independent steps:

Review the [Tavily Terms of Service]((tavily.com/redacted) Then test your configuration with `gh aw mcp inspect <workflow>`.

Or split into distinct sentences/bullets so neither step's completion appears conditional on the other.


[Tavily Terms of Service](https://tavily.com/terms)
Sign up at [tavily.com](https://tavily.com/) to get an API key, then add it as a repository secret:

Test your configuration with `gh aw mcp inspect <workflow>`.
```bash
gh aw secrets set TAVILY_API_KEY --value "<your-api-key>"
```

Review the [Tavily Terms of Service](https://tavily.com/terms), then test the workflow with `gh aw mcp inspect <workflow>`.

## Tool Discovery

To see available tools from the Tavily MCP server:
Inspect the workflow to see which Tavily tools are available:

```bash wrap
# Inspect the MCP server in your workflow
Expand Down
Loading