research
π―Skillfrom tavily-ai/tavily-plugins
Performs AI-powered web research, generating comprehensive reports with citations in structured JSON format.
Installation
npx skills add https://github.com/tavily-ai/tavily-plugins --skill researchSkill Details
Overview
# Tavily Claude Code Plugins
Build AI applications with real-time web data using Tavily's search, extract, crawl, and research APIs.
Step 1: Add Your API Key
Tavily API Key Required β Get your key at https://tavily.com
Open a terminal and run:
```
code ~/.claude/settings.json
```
Copy the following:
```json
{
"env": {
"TAVILY_API_KEY": "tvly-your-api-key-here"
}
}
```
Paste it into your Claude settings.json file, replace with actual API key and save the file.
Step 2: Installation
Run this command in your terminal (Recommended):
```
npx skills add https://github.com/tavily-ai/tavily-plugins
```
Or, run these commands inside Claude Code:
```
/plugin marketplace add tavily-ai/tavily-plugins
```
```
/plugin install tavily@tavily-plugins
```
Step 3: Restart Claude Code
Clear your session and restart to load the plugin:
```
/clear
```
Then press Ctrl+C to restart.
Step 4: Usage
Use the skills by explicitly invoking via slash command, or let Claude decide when to use them:
```
/research
```
```
/crawl-url
```
```
/tavily-api-expert
```
```
/deal-hunt
```
Skills
The plugin includes three skills that Claude can use automatically:
| Skill | Description |
|-------|-------------|
| tavily-api-expert | Reference documentation for Tavily's search, extract, crawl, and research APIs. Claude uses this automatically when you ask it to integrate Tavily into your code. |
| research | CLI tool for AI-synthesized research with citations. Supports structured JSON output. |
| crawl-url | Website crawler that saves pages as local markdown files for offline analysis. |
| deal-hunt | Find the best deals and coupons for any product. Searches the web and returns results for price comparison. |
Usage Examples
Once installed, Claude automatically uses these skills when relevant. Here are some example prompts:
Web Search Integration
```
"Add Tavily search to my agent so it can look up current information"
"Help me implement web search using the Tavily API"
```
Research
```
"Research the latest developments in quantum computing"
"Run the research script on AI agent frameworks and save to report.json"
```
Crawling
```
"Crawl the Stripe API docs and save them locally"
"Download the React documentation for offline reference"
```
Deal Hunting
```
"Find the best deals on AirPods Pro right now"
"Search for PS5 discounts and coupon codes"
"What's the cheapest price for a Dyson V15 this week?"
```
Development
Testing a Branch
To test a new skill or feature from a specific branch, first remove the existing plugin, then add from your branch:
```
/plugin marketplace remove tavily-plugins
/plugin marketplace add tavily-ai/tavily-plugins#your-branch-name
/plugin enable tavily@tavily-plugins
```
This allows you to test changes before merging to main.
Updating the Plugin
When releasing a new version or adding new skills, update the following:
Version (both files must match):
.claude-plugin/plugin.json- update the"version"field.claude-plugin/marketplace.json- update the"version"field inside thepluginsarray
README (when adding/removing skills):
- Update the [Skills](#skills) table with the new skill name and description
- Update the [Usage Examples](#usage-examples) section with use cases
Links
- [Tavily Documentation](https://docs.tavily.com)
- [Tavily Plugins Repository](https://github.com/tavily-ai/tavily-plugins)
- [Tavily Cookbook](https://github.com/tavily-ai/tavily-cookbook)
- [Get API Key](https://tavily.com)
License
MIT