使用说明

项目简介

Tavily API Server 是一个基于 Model Context Protocol (MCP) 的服务器实现，它集成了 Tavily API，为大型语言模型（LLM）应用提供强大的网络搜索和内容提取能力。通过标准化的 MCP 协议，该服务器可以轻松地与各种 MCP 客户端集成，为 LLM 提供实时的上下文信息和外部功能调用能力。

主要功能点

多种搜索工具: 提供 'search' (基础搜索)、'searchContext' (上下文感知搜索)、'searchQNA' (问答式搜索) 三种搜索工具，满足不同的信息检索需求。
内容提取工具: 支持从指定 URL 提取网页内容，方便 LLM 获取网页文本信息。
丰富的配置选项: 搜索和提取工具均提供多种参数配置，如搜索深度、主题、时间范围、内容类型等，可精细控制搜索和提取行为。
标准化 MCP 协议: 采用 JSON-RPC over Stdio 通信，易于集成到支持 MCP 协议的 LLM 应用中。

安装步骤

安装 Node.js: 确保您的系统已安装 Node.js (版本 16 或更高) 和 npm。

安装 @mcptools/mcp-tavily: 您可以通过 npm 全局安装或在项目本地安装 'mcp-tavily' 包。

全局安装 (推荐):

npm install -g @mcptools/mcp-tavily

本地安装 (在您的项目目录中):

npm install @mcptools/mcp-tavily

获取 Tavily API Key: 访问 Tavily 官网注册并获取您的 API Key。

服务器配置

为了让 MCP 客户端能够连接到 Tavily API Server，您需要在客户端的 MCP 配置中添加以下服务器信息。以下是一个 JSON 格式的配置示例，您需要将其添加到您的 MCP 客户端配置中：

{
  "mcpServers": {
    "tavily": {  // 服务器名称，可以自定义
      "command": "npx",  // 启动服务器的命令，这里使用 npx 运行
      "args": ["@mcptools/mcp-tavily"], // 启动服务器的参数，指定运行 @mcptools/mcp-tavily 包
      "env": {
        "TAVILY_API_KEY": "YOUR_TAVILY_API_KEY"  //  Tavily API 密钥，请替换为您的实际 API Key
      }
    }
  }
}

请务必将 'YOUR_TAVILY_API_KEY' 替换为您在 Tavily 官网申请的 API Key。 您也可以将 'TAVILY_API_KEY' 设置为系统环境变量，服务器将自动读取。

基本使用方法

配置完成后，您的 MCP 客户端应该能够检测到名为 'tavily' 的 MCP 服务器。您可以使用客户端提供的界面或 API 调用服务器提供的工具。

例如，您可以使用 'search' 工具进行基础搜索。在 MCP 客户端中，您可以构造一个工具调用请求，指定工具名称为 'tavily/search'，并提供相应的参数，例如：

{
  "tool_call": {
    "tool_name": "tavily/search",
    "parameters": {
      "query": "最新的AI技术发展",
      "options": {
        "topic": "news",
        "timeRange": "week"
      }
    }
  }
}

服务器将返回搜索结果，您可以将这些结果作为上下文信息提供给 LLM。其他工具 ('searchContext', 'searchQNA', 'extract') 的使用方法类似，请参考仓库 README.md 中的 API Reference 部分了解每个工具的具体参数和用法。

关键词