mcpField
T
tavily-sdk

tavily-sdk

github.com/tavily-ai开发490248 次安装2 天前更新
代码仓库

关于 tavily-sdk

Tavily 的 Python 和 JavaScript SDK 为 LLM 应用开发者提供网页搜索与站点内容访问能力。方法涵盖搜索、URL 提取、站点抓取与 URL 发现，以及 AI 综合研究。

主要功能

  1. 01按域名和时间筛选网页搜索
  2. 02提取指定 URL 的内容
  3. 03按语义指令抓取网站
  4. 04发现网站中的 URL
  5. 05生成综合研究结果

适用场景

  1. 01为 AI 应用获取实时网页结果
  2. 02提取文档 URL 中的内容
  3. 03查找并收集网站页面
  4. 04开展带引用的多主题研究

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/tavily-ai/skills --skill tavily-sdk

安装后在 Claude Code 中输入/tavily-sdk确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

references/
crawl.md
extract.md
integrations.md
research.md
sdk.md
search.md

详细介绍

Tavily

Tavily 是一款专为大模型设计的搜索 API，可让 AI 应用访问实时网络数据。

安装

Python：

pip install tavily-python

JavaScript：

npm install @tavily/core

完整的 SDK 参考请参阅 references/sdk.md。

客户端初始化

from tavily import TavilyClient

# Uses TAVILY_API_KEY env var (recommended)
client = TavilyClient()

#With project tracking (for usage organization)
client = TavilyClient(project_id="your-project-id")

# Async client for parallel queries
from tavily import AsyncTavilyClient
async_client = AsyncTavilyClient()

选择合适的方法

用于自定义 Agent/工作流：

需求方法
网页搜索结果search()
特定 URL 的内容extract()
整个网站的内容crawl()
发现网站中的 URLmap()

用于开箱即用的研究：

需求方法
通过 AI 综合分析进行端到端研究research()

快速参考

search() - 网页搜索
response = client.search(
    query="quantum computing breakthroughs",  # Keep under 400 chars
    max_results=10,
    search_depth="advanced"
)
print(response)

关键参数：query、max_results、search_depth（ultra-fast/fast/basic/advanced）、include_domains、exclude_domains、time_range

完整的搜索参考请参阅 references/search.md。

extract() - URL 内容提取
# Simple one-step extraction
response = client.extract(
    urls=["https://docs.example.com"],
    extract_depth="advanced"
)
print(response)

关键参数：urls（最多 20 个）、extract_depth、query、chunks_per_source（1-5）

完整的提取参考请参阅 references/extract.md。

crawl() - 全站内容提取
response = client.crawl(
    url="https://docs.example.com",
    instructions="Find API documentation pages",  # Semantic focus
    extract_depth="advanced"
)
print(response)

关键参数：url、max_depth、max_breadth、limit、instructions、chunks_per_source、select_paths、exclude_paths

完整的爬取参考请参阅 references/crawl.md。

map() - URL 发现
response = client.map(
    url="https://docs.example.com"
)
print(response)
research() - AI 驱动的研究
import time

# For comprehensive multi-topic research
result = client.research(
    input="Analyze competitive landscape for X in SMB market",
    model="pro"  # or "mini" for focused queries, "auto" when unsure
)
request_id = result["request_id"]

# Poll until completed
response = client.get_research(request_id)
while response["status"] not in ["completed", "failed"]:
    time.sleep(10)
    response = client.get_research(request_id)

print(response["content"])  # The research report

关键参数：input、model（"mini"/"pro"/"auto"）、stream、output_schema、citation_format

完整的研究参考请参阅 references/research.md。

详细指南

有关完整参数、响应字段、模式和示例，请参阅：

评论

支持 Markdown