MCP Perplexity

🚀 Project Introduction

This project is created to address some common issues in the development process. It offers a series of powerful tools to assist developers in completing tasks more efficiently.

🚀 Quick Start

📦 Installation

1. Create a virtual environment:

   python -m venv .venv
   source .venv/bin/activate  # Run on Linux/macOS
   # Or run on Windows
   .venv\Scripts\activate
   

2. Install the project:

   pip install -e .
   

3. Build the project:

   python -m build
   

💻 Usage Examples

Command-line Usage

npx -y @smithery/cli@latest run @daniel-lxs/mcp-perplexity --config "{\"perplexityApiKey\":\"pplx-abc\",\"perplexityModel\":\"sonar-pro\"}"

✨ Features

• Maintain Conversation History: Support continuous conversations, with each conversation having a unique ID.
• Paginated Conversation List: Facilitate the management of a large number of conversation records.
• Real-time Message Display: Provide an intuitive chat interface through the Web UI.
• Local Database Access: Read conversation history without an internet connection.

📚 Documentation

Components

Tool Introduction

ask_perplexity

The ask_perplexity tool is used to answer specific questions. Each request is treated as a new conversation. This tool will use the PERPLEXITY_MODEL_ASK model (if specified) or the default PERPLEXITY_MODEL to generate responses.

chat_perplexity

The chat_perplexity tool is used to maintain a continuous conversation history. Each conversation has a unique ID, which is returned when a new conversation is created. You can specify the page number to view (50 records per page) by providing the page parameter (default is 1).

list_chats_perplexity

The list_chats_perplexity tool is used to list all available conversation records. It returns the conversation list in a paginated format, displaying the ID, title, and creation time (relative format) of each conversation. By default, 50 records are displayed per page.

read_chat_perplexity

The read_chat_perplexity tool is used to retrieve the complete conversation history of a specified chat_id. This tool returns all messages, including time and role information. It does not initiate any API requests to Perplexity and only reads data from the local database.

Web UI

Functional Features

• Interactive Chat Interface: Provide an intuitive conversation experience.
• Chat History Management: Facilitate the viewing and operation of all conversation records.
• Real-time Message Display: Support instant message updates.

Access Method

When WEB_UI_ENABLED is set to true, the Web UI can be accessed via the address http://WEB_UI_HOST:WEB_UI_PORT, with the default being http://localhost:8080.

Development Guide

• Code Structure: The project adopts a modular design for easy expansion and maintenance.
• Logging System: Integrate detailed logging to assist with debugging and monitoring.

Contribution Guide

Contributions are welcome! Please refer to the project's GitHub repository for more information.

🔧 Technical Details

Environment Variable Configuration

The following are all supported environment variables and their default values: