MCP Database Console

A revolutionary web application that bridges the gap between natural language and database queries

🚀 Quick Start • 📖 Documentation • 🤝 Contributing

🚀 What is MCP Database Console?

MCP Database Console is a cutting-edge web application that transforms natural language into powerful database queries. Built with Next.js and powered by the MCP-DB Connector, it democratizes database access by allowing users to interact with databases using plain English instead of complex SQL syntax.

🎯 The Problem We Solve

SQL Complexity: Writing SQL queries requires technical expertise and knowledge of database schemas
Accessibility: Non-technical users struggle to extract insights from databases
Time Consumption: Developers spend significant time writing and debugging SQL queries
Learning Curve: New team members need time to understand database structures

💡 Our Solution

Transform natural language into powerful database queries through an intuitive web interface that:

Understands Context: Interprets user intent from conversational prompts
Supports Multiple Databases: Works with SQLAlchemy and Snowflake databases
Provides Real-time Results: Shows query results instantly in formatted tables
Handles Errors Gracefully: Offers helpful error messages and suggestions

🌟 Key Benefits

Democratize Data Access: Enable non-technical users to query databases
Increase Productivity: Reduce time spent on query writing and debugging
Improve Accuracy: Minimize SQL syntax errors through natural language processing
Enhance Collaboration: Allow team members to share insights without SQL knowledge

🎉 Hacktoberfest 2025

This repository is participating in Hacktoberfest 2025! We welcome contributions from developers of all skill levels. After 15 approved pull requests, you'll be recognized as a project contributor!

Quick Start for Contributors

Fork this repository
Star the repository (optional but appreciated!)
Check our Contributing Guidelines
Look for issues labeled hacktoberfest or good first issue
Create a pull request with your contribution
Get recognized as a contributor after 15 approved PRs!

👥 Use Cases

🏢 Business Analysts

Quick Data Insights: Get answers to business questions without waiting for developers
Ad-hoc Reporting: Create reports on-demand using natural language
Data Exploration: Discover patterns and trends in company data

👨‍💼 Product Managers

User Analytics: Understand user behavior and product metrics
Feature Analysis: Analyze feature adoption and performance
Competitive Intelligence: Gather insights from market data

🎓 Data Scientists

Rapid Prototyping: Quickly test hypotheses with natural language queries
Data Validation: Verify data quality and consistency
Exploratory Analysis: Initial data exploration before deep analysis

🏭 Operations Teams

System Monitoring: Query system logs and performance metrics
Incident Analysis: Investigate issues using natural language
Capacity Planning: Analyze resource usage patterns

🎓 Students & Researchers

Learning SQL: Understand database concepts through natural language
Research Data: Query academic databases and research datasets
Project Analysis: Analyze project data for academic research

🎯 MVP (Minimum Viable Product)

Core Features ✅

Natural Language Query Interface: Basic English-to-SQL conversion
Database Support: SQLAlchemy and Snowflake connectors
Results Display: Formatted table output with query execution time
Error Handling: User-friendly error messages and validation
Responsive UI: Clean, modern interface built with TailwindCSS

Current Status: MVP Complete 🚀

🚀 Quick Start

Prerequisites

Node.js 18+
npm or pnpm
MCP-DB Connector server running on http://localhost:8000

Installation

Clone the repository

git clone https://github.com/Limeload/mcp-for-database.git
cd mcp-for-database

Install dependencies
```
npm install
# or
pnpm install
```
Start the development server
```
npm run dev
```
Open your browser Navigate to http://localhost:3000

Usage

Database Console

Navigate to /db-console to access the database query interface:

Enter a Prompt: Describe what you want to query in natural language
- Example: "Show me all users who registered in the last 30 days"
- Example: "Find the top 10 products by sales"
Select Database Target: Choose between:
- SQLAlchemy: For SQLAlchemy-based applications
- Snowflake: For Snowflake data warehouse
Execute Query: Click "Execute Query" to run your prompt
View Results: Results are displayed in a formatted table with:
- Generated SQL query (if available)
- Query execution time
- Data results in tabular format

📖 Documentation

Contributing Guidelines - How to contribute to the project
Code of Conduct - Community standards and behavior
Security Policy - Security guidelines and vulnerability reporting
Contributors - List of project contributors
Roadmap - Detailed development roadmap and future plans
API Documentation - Complete API reference
Development Guide - Development setup and guidelines
Deployment Guide - Deployment options and instructions

🔧 API Reference

POST `/api/db/[query]`

Execute a database query using natural language.

Request Body:

{
  "prompt": "string",
  "target": "sqlalchemy" | "snowflake"
}

Response:

{
  "success": true,
  "data": [...],
  "query": "SELECT ...",
  "executionTime": 150
}

Error Response:

{
  "success": false,
  "error": "Error message"
}

⚙️ Configuration

MCP Server

The application expects the MCP-DB Connector server to be running on http://localhost:8000. Update the URL in /app/api/db/[query]/route.ts if your MCP server runs on a different port.

Environment Variables

Create a .env.local file in the root directory:

# MCP Server Configuration
MCP_SERVER_URL=http://localhost:8000

# Database Configuration (if needed)
DATABASE_URL=your_database_url

TailwindCSS

The project uses TailwindCSS for styling. Configuration files:

tailwind.config.js - TailwindCSS configuration
postcss.config.js - PostCSS configuration
app/globals.css - Global styles

🧪 Development

Available Scripts

# Development
npm run dev          # Start development server
npm run build        # Build for production
npm run start        # Start production server
npm run lint         # Run ESLint

# Testing
npm test             # Run tests (when implemented)

Building for Production

npm run build
npm start

TypeScript

The project is fully typed with TypeScript. All API responses and component props are properly typed.

🛡️ Error Handling

The application includes comprehensive error handling:

Network Errors: When the MCP server is unreachable
Validation Errors: For missing or invalid request parameters
Server Errors: When the MCP server returns an error
Client Errors: For malformed requests

All errors are displayed to the user with clear, actionable messages.

🤝 Contributing

We welcome contributions from the community! This project is participating in Hacktoberfest 2025.

For Contributors

📖 Read our Contributing Guidelines
📋 Check our Code of Conduct
🏆 See our Contributors page
🎯 Look for issues labeled hacktoberfest or good first issue

Quick Contribution Steps

Fork the repository
Create a feature branch (git checkout -b feature/amazing-feature)
Make your changes
Test thoroughly
Commit your changes (git commit -m 'Add amazing feature')
Push to the branch (git push origin feature/amazing-feature)
Open a Pull Request

Recognition

After 15 approved pull requests, you'll be:

Added to our Contributors list
Recognized as a project contributor
Eligible for Hacktoberfest completion

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

Next.js team for the amazing framework
TailwindCSS for the utility-first CSS framework
MCP-DB Connector for the database integration
Hacktoberfest community for inspiring open-source contributions

Made with ❤️ for the open-source community

⭐ Star this repo • 🐛 Report Bug • ✨ Request Feature

Name		Name	Last commit message	Last commit date
Latest commit History 52 Commits
.github		.github
app		app
docs		docs
scripts		scripts
.eslintrc.json		.eslintrc.json
.gitignore		.gitignore
.prettierignore		.prettierignore
.prettierrc		.prettierrc
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
CONTRIBUTORS.md		CONTRIBUTORS.md
LICENSE		LICENSE
README.md		README.md
SECURITY.md		SECURITY.md
next.config.ts		next.config.ts
package-lock.json		package-lock.json
package.json		package.json
pnpm-lock.yaml		pnpm-lock.yaml
postcss.config.js		postcss.config.js
tailwind.config.js		tailwind.config.js
tsconfig.json		tsconfig.json

License

Shristibot/mcp-for-database

Folders and files

Latest commit

History

Repository files navigation