使用说明
项目简介
'zenturacp_tavily-server' 是一个实现了 Model Context Protocol (MCP) 的服务器,它利用 Tavily API 提供了强大的技术搜索功能。该服务器旨在为大型语言模型 (LLM) 客户端提供代码示例、技术文档、调试解决方案和学习资源等上下文信息,从而增强 LLM 在编程和技术领域的应用能力。
主要功能点
- 技术搜索工具 (Tool): 提供 'search' 工具,允许 LLM 客户端通过发送自然语言查询,获取来自 Tavily API 的技术搜索结果。
- 多种搜索类型: 支持四种类型的技术搜索,包括:
- 'code': 查找代码示例和实现方案。
- 'docs': 搜索技术文档和 API 参考。
- 'debug': 寻找调试解决方案和错误修复方法。
- 'learn': 探索学习资源和教程。
- 结构化结果: 服务器会将 Tavily API 返回的原始搜索结果进行处理和结构化,提取关键信息(如代码块、文档内容、解决方案等),并以易于 LLM 理解和利用的格式返回。
安装步骤
- 安装 Node.js 和 npm: 确保你的计算机上已安装 Node.js 和 npm (Node.js 包管理器)。你可以从 nodejs.org 下载并安装。
- 克隆仓库: 使用 git 命令克隆 'zenturacp_tavily-server' 仓库到本地:
git clone https://github.com/MCP-Mirror/zenturacp_tavily-server.git - 进入仓库目录: 使用 'cd' 命令进入克隆下来的仓库目录:
cd zenturacp_tavily-server - 安装依赖: 运行 'npm install' 命令安装项目所需的依赖包:
npm install - 构建项目: 运行 'npm run build' 命令编译 TypeScript 代码:
npm run build - 设置 Tavily API 密钥: 你需要拥有一个 Tavily API 密钥才能使用该服务器。访问 Tavily 官网 注册并获取 API 密钥。获取密钥后,将其设置为名为 'TAVILY_API_KEY' 的环境变量。 设置环境变量的方法取决于你的操作系统,例如在 macOS 或 Linux 中,你可以在 '~/.bashrc' 或 '~/.zshrc' 文件中添加 'export TAVILY_API_KEY=你的API密钥',然后运行 'source ~/.bashrc' 或 'source ~/.zshrc' 使环境变量生效。
服务器配置
要将 'zenturacp_tavily-server' 集成到 MCP 客户端(例如 Claude Desktop),你需要在客户端的 MCP 服务器配置文件中添加以下配置信息。请根据你的实际安装路径修改 'command' 字段。
{ "mcpServers": { "tavily-search-server": { "command": "/path/to/zenturacp_tavily-server/build/index.js" } } }
- 'tavily-search-server': 这是你为该 MCP 服务器定义的名称,在客户端中用于识别和调用该服务器。你可以自定义这个名称。
- 'command': 这是服务器的启动命令,指向 'zenturacp_tavily-server' 项目构建后的入口文件 'index.js'。你需要将 '/path/to/zenturacp_tavily-server' 替换为你本地仓库的绝对路径。例如,如果你的仓库位于 '/Users/yourname/Documents/zenturacp_tavily-server',则 'command' 应该设置为 '/Users/yourname/Documents/zenturacp_tavily-server/build/index.js'。
请注意: MCP 客户端通常会自动处理服务器的启动和连接,你只需要在配置文件中提供正确的 'command' 即可。无需手动指定其他参数或运行复杂的命令。
基本使用方法
-
启动服务器: 在配置好 MCP 客户端后,客户端通常会自动启动配置的 MCP 服务器。如果需要手动启动,可以在 'zenturacp_tavily-server' 仓库目录下运行以下命令:
npm run start或者直接运行构建后的 'index.js' 文件:
node build/index.js -
在 LLM 应用中使用: 在支持 MCP 协议的 LLM 应用中,你可以指示 LLM 调用 'search' 工具来执行技术搜索。例如,你可以向 LLM 发送指令,要求它“使用 'search' 工具搜索关于 React Hooks 'useEffect' 的代码示例”。
LLM 应用会根据你的指令,构建符合 MCP 协议的 'CallToolRequest' 请求,并发送给 'zenturacp_tavily-server'。服务器接收到请求后,会调用 Tavily API 进行搜索,并将结果返回给 LLM 应用,最终 LLM 应用会将搜索结果呈现给你。
信息
分类
开发者工具