Doris MCP Server

🚀 Doris

Doris is a powerful Natural Language Processing (NLP) tool designed for data query and analysis. It can transform complex natural language queries into efficient SQL and offer professional data analysis services.

🚀 Quick Start

Doris is a robust NLP tool crafted for data query and analysis. It excels at converting intricate natural language queries into efficient SQL and offers professional data - analysis services.

✨ Features

• Multi - table Join Support: Effortlessly handle complex relationships among multiple database tables.
• Intelligent Context Understanding: Optimize results based on historical queries and business context.
• Interpretable Output: Provide clear and understandable result explanations, suitable for non - technical users.
• Real - time Data Analysis: Respond quickly to user queries and generate analysis results.

📦 Installation

Environment Requirements

• Operating System: Linux, Windows 10 or higher.
• Memory: At least 4GB RAM.
• Python Version: 3.8 or higher.

Installation Steps

# Clone the repository
git clone https://github.com/your-repository.git
cd Doris

# Install dependencies
pip install -r requirements.txt

# Start the service
python start_server.py

💻 Usage Examples

Basic Usage

1. Initial Configuration

# Configure database connection information
configuresettings --database-settings

2. Execute Queries

# Execute a single - table query
doristool query "Show contact information of all customers"

# Execute a cross - table joint query
doristool join-query "Calculate the quarterly sales of each sales representative"

3. Get Results

• Query results will be output to the console, and an analysis report will be automatically generated.

Advanced Usage

Multi - step Query Process

1. Parse a natural language query

parse_query --query="Show the total sales of each sales representative in 2022"

2. Get similar query examples

find_similar_examples --query="Show the total sales of each sales representative in 2022"

3. Generate optimized SQL

generate_sql --query="Show the total sales of each sales representative in 2022"

4. Execute and analyze results

exec_query --sql="SELECT SUM(sales) AS total_sales, representative_id FROM sales GROUP BY representative_id;"
analyze_query_result --resultsetId=123

📚 Documentation

Database Configuration

Edit the config/database_config.json file:

{
  "host": "localhost",
  "port": 3306,
  "user": "root",
  "password": "your_password",
  "databases": ["sales", "customer"]
}

Log Settings

Edit the config/logging_settings.json file:

{
  "log_level": "INFO",
  "log_file": "doris.log"
}

Error Handling

Common errors and solutions:

1. Database connection failure
   • Check if the database service is running.
   • Ensure the credential information is correct.
2. SQL execution timeout
   • Optimize the query statement.
   • Adjust the indexing strategy.
3. Empty analysis results
   • Validate the query conditions.
   • Check data integrity.

Contribution Guidelines

Welcome to contribute to the project by submitting issues or pull requests. Please refer to the CONTRIBUTING.md file for the specific process.

📄 License

This project is licensed under the MIT License, as follows:

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Appendix

Doris Usage Instructions

Doris provides the following main tools:

• parse_query: Parse natural language queries.
• find_similar_examples: Get similar query examples.
• generate_sql: Generate optimized SQL statements.
• exec_query: Execute SQL queries.
• analyze_query_result: Analyze query results.

Workflow Diagram

Start
    |
    v
Receive natural language query
    |
    v
parse_query
    |
    v
find_similar_examples (Optional)
    |
    v
generate_sql
    |
    v
exec_query
    |
    v
analyze_query_result
    |
    v
Output results and analysis report

Examples

1. Basic Query

doristool query "Show contact information of all customers"

2. Complex Query

doristool join-query "Calculate the quarterly sales of each sales representative"

3. Custom Script

from doris import DorisClient

client = DorisClient()
result = client.query("Show the total number of orders in the past year")
print(result)

Thank you for using Doris! Please contact the maintenance team if you need help.