article
README
🚀 MCP Tavily 项目
一个为 Tavily API 实现的模型上下文协议(MCP)服务器,提供高级搜索和内容提取功能,助力用户高效获取信息。
✨ 主要特性
- 多个搜索工具:
search:具备自定义选项的基本搜索功能,满足多样化搜索需求。searchContext:上下文感知搜索,有效提高搜索结果的相关性。searchQNA:专注于问答场景的搜索功能,精准定位答案。
- 内容提取:可从 URL 中提取内容,且带有可配置的选项,方便灵活使用。
- 丰富的配置选项:涵盖搜索深度、过滤和内容包含等方面,提供大量配置选项。
📦 安装指南
安装依赖
npm install
设置步骤
- 克隆仓库。
- 安装依赖:
npm install - 配置您的 Tavily API 密钥:
export TAVILY_API_KEY=your_api_key
构建项目
npm run build
💻 使用示例
使用 MCP 配置
将 Tavily MCP 服务器添加到您的 MCP 配置中:
{
"mcpServers": {
"tavily": {
"command": "npx",
"args": ["-y", "@mcptools/mcp-tavily"],
"env": {
"TAVILY_API_KEY": "your-api-key"
}
}
}
}
⚠️ 重要提示
请将
your-api-key替换为您的实际 Tavily API 密钥。
📚 详细文档
API 参考
搜索工具
- search:基本搜索功能,支持自定义过滤和排序选项。
- searchContext:提供上下文感知的搜索结果,增强相关性。
- searchQNA:聚焦于问答场景的搜索功能。
提取工具
- extract:从指定 URL 中提取结构化内容。
响应格式
所有工具的响应都遵循统一的数据格式,确保兼容性和易用性。
错误处理
详细的错误信息和状态码,帮助开发者快速定位问题。
使用 MCP 监视器调试
推荐使用 MCP Inspector 进行开发和调试,它提供:
- 工具调用测试界面
- 服务器响应查看
- 调试工具执行
- 服务器状态监控
🤝 贡献指南
欢迎贡献!请按照以下步骤提交 Pull Request:
- 叉叉仓库。
- 创建功能分支 (
git checkout -b feature/AmazingFeature)。 - 提交更改 (
git commit -m 'Add some AmazingFeature')。 - 推送到分支 (
git push origin feature/AmazingFeature)。 - 打开 Pull Request。
📄 许可证
本项目使用 MIT 许可证。
🛠️ 支持
如需帮助或遇到问题:
Scan to contact