# Revornix

> MCP Client

**Option 1 (Focus on summarization):**

MCP-powered document & news manager. Auto-summaries, notifications, & customizable model support.

**Option 2 (Focus on document interaction):**

Document/news 

## Overview

- **Category:** AI
- **Language:** TypeScript
- **Stars:** 188
- **Forks:** 14
- **Owner:** Qingyon-AI
- **GitHub:** https://github.com/Qingyon-AI/Revornix
- **Homepage:** https://revornix.com
- **Created:** 2025-04-06T08:03:12+00:00
- **Updated:** 2025-08-08T09:02:53+00:00
- **Source:** https://model-context-protocol.com/clients/revornix

## Setup

## Setup

This guide provides instructions for setting up Revornix using Docker (recommended) or manual deployment.

### Docker Method (Recommended)

This method uses Docker Compose to orchestrate the various Revornix services.

**Prerequisites:**

*   Docker: Ensure Docker is installed and running on your system.  Refer to the official Docker documentation for installation instructions: [https://docs.docker.com/get-docker/](https://docs.docker.com/get-docker/)
*   Docker Compose: Ensure Docker Compose is installed.  Most Docker installations include Docker Compose by default.  If not, refer to the official Docker Compose documentation: [https://docs.docker.com/compose/install/](https://docs.docker.com/compose/install/)
*   Git:  Git is required to clone the Revornix repository.

**Installation Steps:**

1.  **Clone the Repository:**

    ```shell
    git clone git@github.com:Qingyon-AI/Revornix.git
    cd Revornix
    ```

2.  **Configure Environment Variables:**

    *   Copy the example environment file:

        ```shell
        cp .env.example .env
        ```

    *   Edit the `.env` file to configure the necessary environment variables. Refer to the [Environment Variables Configuration](https://revornix.com/en/docs/environment) documentation for detailed descriptions of each variable.

        ```shell
        nano .env # Or your preferred text editor
        ```

    *   **Important Environment Variables:**

        *   `OAUTH_SECRET_KEY`:  This is crucial for user authentication.  **It must be consistent across all Revornix services.**  Generate a strong, random key and set it in the `.env` file.  If this key is not consistent, user authentication will fail.

        *   Other variables can be left as default in most cases, but review the documentation to understand their purpose and adjust as needed.

3.  **Start the Services with Docker Compose:**

    ```shell
    docker compose up -d
    ```

    This command will pull the necessary Docker images and start all the Revornix services in detached mode (running in the background).

4.  **Access Revornix:**

    Once all services are started, you can access the front-end application in your web browser at:

    ```
    http://localhost
    ```

    **Troubleshooting:**

    *   The front-end may take some time (10-15 minutes) to become fully functional after the services are started, as the back-end services need time to initialize.
    *   You can check the status of the core back-end service using the following command:

        ```shell
        docker compose logs api
        ```

        This will display the logs for the `api` service, allowing you to identify any potential errors.

### Manual Deployment Method

For detailed instructions on manual deployment, please refer to the official documentation: [official documentation manual deployment method](https://revornix.com/en/docs/start#manual-deployment-method)

## Tools

## Available Tools

Here's a breakdown of Revornix's features, presented as tools with their functions:

*   **Cross-Platform Access:** Access Revornix through the web. iOS app and WeChat Mini Program support are planned.
    *   **Function:** Provides access to Revornix on different devices.
    *   **Usage:** Access the web version through a browser.

*   **Content Aggregator:** Collects and centralizes content from various sources like news, blogs, and forums.
    *   **Function:** Gathers information from different online sources into a single location.
    *   **Usage:** Configure the tool to monitor specific websites or feeds.

*   **Document Transformation & Vectorization:** Converts files to Markdown format and embeds them using multimodal large models, storing them in Milvus.
    *   **Function:** Converts documents into a structured format suitable for AI processing and efficient storage.
    *   **Usage:** Upload documents, and the tool automatically converts and stores them.

*   **Multi-Tenancy:** Supports multiple users with independent document repositories.
    *   **Function:** Allows multiple users to use the system concurrently, each with their own data.
    *   **Usage:** Each user logs in and has access to their own workspace.

*   **Localization & Open Source:** Open-source code with local data storage.
    *   **Function:** Ensures data privacy and allows for customization.
    *   **Usage:** Deploy the open-source code on a local server.

*   **Smart Assistant (with built-in MCP):** An AI assistant that interacts with documents and tools, supporting multi-model switching.
    *   **Function:** Provides AI-powered assistance for interacting with and managing documents.
    *   **Usage:** Ask the assistant questions about your documents or request it to perform tasks.

*   **LLM Integration:** Supports integration with various Large Language Models (LLMs), requiring OpenAI-compatible models.
    *   **Function:** Allows users to choose and configure their preferred LLM for AI processing.
    *   **Usage:** Configure the tool with the API key of your chosen LLM.

*   **Multilingual Support:** Supports both Chinese and English languages.
    *   **Function:** Provides a user interface in multiple languages.
    *   **Usage:** Select your preferred language in the settings.

*   **Responsive Design:** Provides a good user experience on both mobile and desktop devices.
    *   **Function:** Adapts the user interface to different screen sizes.
    *   **Usage:** Access the tool on any device, and the interface will adjust accordingly.