grok-search

Grok Search

Enhanced web search via Grok API. Standalone CLI only (no MCP dependency).

Implementation Layout

• scripts/groksearch_cli.py - CLI entrypoint and compatibility facade
• scripts/groksearch/ - internal modules for config, HTTP retry, Grok provider, Tavily calls, formatting, and commands

Execution Methods

Run scripts/groksearch_cli.py via Bash:

# Prerequisites: pip install httpx tenacity
# Environment: GROK_API_URL, GROK_API_KEY (required); TAVILY_API_KEY (optional)

# Web search (Grok only)
python scripts/groksearch_cli.py web_search --query "search terms" [--platform "GitHub"] [--min-results 3] [--max-results 10]

# Web search with Tavily extra sources (parallel + URL-deduplicated merge)
python scripts/groksearch_cli.py web_search --query "..." --extra-sources 5

# Fetch webpage (default: Grok)
python scripts/groksearch_cli.py web_fetch --url "https://..." [--out file.md]

# Fetch via Tavily extract endpoint
python scripts/groksearch_cli.py web_fetch --url "https://..." --via tavily

# Map a website's structure (Tavily)
python scripts/groksearch_cli.py web_map --url "https://docs.example.com" [--instructions "API only"] [--max-depth 2] [--max-breadth 20] [--limit 50] [--timeout 150]

# Check config
python scripts/groksearch_cli.py get_config_info [--no-test]

# Switch model
python scripts/groksearch_cli.py switch_model --model "grok-2-latest"

# Toggle built-in tools
python scripts/groksearch_cli.py toggle_builtin_tools --action on|off|status [--root /path/to/project]

Tool Routing Policy

Forced Replacement Rules

| Scenario | Disabled | Force Use | |----------|----------|-----------| | Web Search | WebSearch | CLI web_search | | Web Fetch | WebFetch | CLI web_fetch |

Tool Capability Matrix

| Tool | Parameters | Output | |------|------------|--------| | web_search | query(required), platform/min_results/max_results(optional), extra_sources(int, 0=disabled) | [{title,url,description,provider?}] | | web_fetch | url(required), out(optional), via(grok\|tavily, default grok) | Structured Markdown | | web_map | url(required), instructions/max_depth/max_breadth/limit/timeout(optional) | {base_url,results,response_time} JSON | | get_config_info | no_test(optional) | {api_url,status,connection_test,tavily_*} | | switch_model | model(required) | {previous_model,current_model} | | toggle_builtin_tools | action(on/off/status), root(optional) | {blocked,deny_list} |

Search Workflow

Phase 1: Query Construction

• Intent Recognition: Broad search → web_search | Deep retrieval → web_fetch
• Parameter Optimization: Set platform for specific sources, adjust result counts

Phase 2: Search Execution

1. Start with web_search for structured summaries
2. Use web_fetch on key URLs if summaries insufficient
3. Retry with adjusted query if first round unsatisfactory

Phase 3: Result Synthesis

1. Cross-reference multiple sources
2. Must annotate source and date for time-sensitive info
3. Must include source URLs: Title [<sup>1</sup>](URL)

Error Handling

| Error | Recovery | |-------|----------| | Connection Failure | Run get_config_info, verify API URL/Key | | No Results | Broaden search terms | | Fetch Timeout | Try alternative sources |

Anti-Patterns

| Prohibited | Correct | |------------|---------| | No source citation | Include Source [<sup>1</sup>](URL) | | Give up after one failure | Retry at least once | | Use built-in WebSearch/WebFetch | Use GrokSearch tools/CLI |