[docs] docs: unbloat web search guide - #46940
Conversation
github-actions
Bot
added
automation
doc-unbloat
documentation
|
✅ Following Agentic Workflow Model Thanks to the gh-aw automation team! This PR is an output of the "Documentation Unbloat" agentic workflow, which aligns with how this repository handles contributions (core team implements via agents). Status Assessment:
Why this needs a look:
Suggestion: Mark as ready for review and assign to a maintainer who can verify the web-search guide examples remain accurate.
|
There was a problem hiding this comment.
Pull request overview
Note
Copilot could not run the full agentic suite for this review because it was automatically requested on a bot-authored pull request. Request a review from Copilot under Reviewers to retry with the full agentic suite. Improved support for bot-authored pull requests is coming soon.
Updates the web search reference doc to be more concise and consistently formatted, with clearer setup instructions for Tavily MCP.
Changes:
- Rewrites the intro and Tavily description to be shorter and more direct.
- Converts the setup section into a proper heading with a dedicated bash snippet for the secret command.
- Clarifies the wording around tool discovery and workflow inspection.
Show a summary per file
| File | Description |
|---|---|
| docs/src/content/docs/reference/web-search.md | Refines Tavily web search documentation phrasing and setup instructions formatting. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 2
- Review effort level: Low
|
|
||
| [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). | ||
|
|
|
|
||
| [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 Quality Sentinel completed test quality analysis. No test files were added or modified in this PR. Test Quality Sentinel skipped. |
|
🧠 Matt Pocock Skills Reviewer has completed the skills-based review. ✅ |
|
✅ Design Decision Gate 🏗️ completed the design decision gate check. No ADR enforcement needed: PR #46940 does not have the 'implementation' label and has 0 new lines of code in business logic directories (threshold: 100). |
|
✅ PR Code Quality Reviewer completed the code quality review. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Clean documentation refactor. The changes reduce prose bloat, promote the setup steps into a proper section, and add a fenced code block for the CLI command — all good improvements.
🧵 Reviewed using Impeccable skills by Impeccable Skills Reviewer · 7.95 AIC · ⌖ 4.3 AIC · ⊞ 5K
There was a problem hiding this comment.
Skills-Based Review 🧠
Applied /grill-with-docs — docs-only change, no architectural concerns.
The condensed intro and converted numbered-list → command-block are clear improvements. Existing review comments (fence type, placeholder style) already cover the two minor issues present. No blocking changes needed.
🧠 Reviewed using Matt Pocock's skills by Matt Pocock Skills Reviewer · 8.83 AIC · ⌖ 6.77 AIC · ⊞ 6.7K
Comment /matt to run again
There was a problem hiding this comment.
Doc-only change — non-blocking observations
This PR condenses intro and setup copy in web-search.md without losing any essential content. No code or workflow logic is changed.
One low-severity finding raised inline (line 36): the word then in "Review the ToS, then test the workflow" implies sequential dependency between unrelated actions. Separating the sentences removes the false prerequisite.
Existing review comments (aw fence type, placeholder style) are not re-raised.
🔎 Code quality review by PR Code Quality Reviewer · 18.7 AIC · ⌖ 4.41 AIC · ⊞ 5.6K
Comment /review to run again
| **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 |
There was a problem hiding this comment.
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.
|
🎉 This pull request is included in a new release. Release: |
Summary
Simplifies and tightens the web search reference guide (
docs/src/content/docs/reference/web-search.md).Changes
docs/src/content/docs/reference/web-search.mdbashcode block; clarified Tool Discovery section headingImpact
Commits
7d426d9b7docs: unbloat web search guide