Tavily

🚀 MCP Tavily Project

Chinese Documentation

A Model Context Protocol (MCP) server implemented for the Tavily API, offering advanced search and content extraction capabilities.

✨ Features

• Multiple Search Tools:
  • search: Basic search functionality with customizable options.
  • searchContext: Context-aware search to enhance relevance.
  • searchQNA: Search focused on question-and-answer scenarios.
• Content Extraction: Extract content from URLs with configurable options.
• Rich Configuration Options: A wide range of options including search depth, filtering, and content inclusion.

Using MCP Configuration

Add the Tavily MCP server to your MCP configuration:

{
  "mcpServers": {
    "tavily": {
      "command": "npx",
      "args": ["-y", "@mcptools/mcp-tavily"],
      "env": {
        "TAVILY_API_KEY": "your-api-key"
      }
    }
  }
}

⚠️ Important Note

Replace your-api-key with your actual Tavily API key.

📚 Documentation

API Reference

Search Tools

• search
  • Basic search functionality supporting custom filtering and sorting options.
• searchContext
  • Provides context-aware search results to enhance relevance.
• searchQNA
  • Search functionality focused on question-and-answer scenarios.

Extraction Tools

• extract
  • Extract structured content from the specified URL.

Response Format

The responses of all tools follow a unified data format to ensure compatibility and ease of use.

Error Handling

Detailed error messages and status codes help developers quickly locate issues.

📦 Installation

npm install

Setup

1. Clone the repository.
2. Install dependencies:

   npm install
   

3. Configure your Tavily API key:

   export TAVILY_API_KEY=your_api_key
   

Build

npm run build

💻 Usage Examples

Using MCP Inspector for Debugging

It is recommended to use MCP Inspector for development and debugging, which provides:

• A test interface for tool calls.
• A view for server responses.
• Debugging tool execution.
• Server status monitoring.

🤝 Contribution Guidelines

Contributions are welcome! Please follow these steps to submit a Pull Request:

1. Fork the repository.
2. Create a feature branch (git checkout -b feature/AmazingFeature).
3. Commit your changes (git commit -m 'Add some AmazingFeature').
4. Push to the branch (git push origin feature/AmazingFeature).
5. Open a Pull Request.

📄 License

This project is licensed under the MIT License.

🆘 Support

If you need help or encounter issues:

• For Tavily API: Refer to Tavily Documentation.
• For MCP integration: Refer to MCP Documentation.