JDBC Database Connector

🚀 MCP-JDBC-Server

MCP-JDBC-Server is an implementation of the Model Context Protocol (MCP), supporting database operations via JDBC interfaces and integration of AI assistant features.

🚀 Quick Start

MCP-JDBC-Server is an implementation of the Model Context Protocol (MCP), which supports database operations through the JDBC interface and integrates AI assistant features. This project documentation details how to use the server for database interactions and specific functions with the Virtuoso database.

📦 Installation

1. Download MCP-JDBC-Server

Download the latest version of MCP-JDBC-Server from GitHub and extract it to a local directory.

2. Install Dependencies

Ensure the following software is installed:

• JDK 8 or higher: Required to run Java programs.
• Maven: Used for managing project dependencies and building.
• Node.js and npm: Needed to run MCP components (e.g., Inspector).

3. Configure Environment Variables

Set the following environment variables to ensure the project runs smoothly:

• JAVA_HOME: Point to the JDK installation directory.
• PATH: Include the executable paths of Node.js and Maven.

💻 Usage Examples

1. Start MCP-JDBC-Server

Run the following command in the terminal to start the server:

java -jar mcp-jdbc-server-1.0.0-runner.jar

2. Configure Database Connection

Edit the config.properties file to configure database connection information (e.g., JDBC URL, username, and password).

3. Use MCP Components

Install and run the MCP Inspector for debugging with the following commands:

npm install -g @modelcontextprotocol/inspector
npx @modelcontextprotocol/inspector java -jar mcp-jdbc-server-1.0.0-runner.jar

Access the provided URL to view server interaction information.

✨ Features

Database Operations

MCP-JDBC-Server provides standard SQL operation functions, including:

• Query Data: Execute SELECT statements and return results.
• Update Data: Execute INSERT, UPDATE, and DELETE statements.
• Transaction Management: Support explicit transaction control.

AI Assistant Integration

Through specific functions of the Virtuoso database, MCP-JDBC-Server integrates AI assistant features:

• SPASQL Queries: Combine SQL and SPARQL for complex data analysis.
• SPARQL Support: Directly execute SPARQL statements and obtain results.
• AI Support: Utilize Virtuoso's AI assistant functions to provide intelligent query capabilities via an API Key.

💻 Usage Examples

Basic Usage

import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.PreparedStatement;
import java.sql.ResultSet;

public class MCPJDBCExample {
    public static void main(String[] args) {
        String url = "jdbc:mysql://localhost:3306/mydatabase";
        String user = "root";
        String password = "password";

        try {
            Connection connection = DriverManager.getConnection(url, user, password);
            PreparedStatement statement = connection.prepareStatement("SELECT * FROM mytable");
            ResultSet result = statement.executeQuery();

            while (result.next()) {
                System.out.println(result.getString(1));
            }

            connection.close();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

Advanced Usage

import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.CallableStatement;
import java.sql.SQLException;

public class AIAssistantExample {
    public static void main(String[] args) {
        String url = "jdbc:mysql://localhost:3306/mydatabase";
        String user = "root";
        String password = "password";

        try {
            Connection connection = DriverManager.getConnection(url, user, password);
            CallableStatement statement = connection.prepareCall("{?=CALL DEMO.DBA.OAI_VIRTUOSO_SUPPORT_AI(?)}");
            
            String prompt = "Please explain quantum computing.";
            statement.setString(2, prompt);

            statement.execute();
            ResultSet result = statement.getResultSet();

            while (result.next()) {
                System.out.println(result.getString(1));
            }

            connection.close();
        } catch (SQLException e) {
            e.printStackTrace();
        }
    }
}

📚 Documentation

1. Server Fails to Start

• Solution: Check if the environment variables are configured correctly and ensure that JDK and Maven are installed properly.

2. Database Connection Fails

• Solution: Verify the database URL, username, and password, and ensure that the database service is running.

3. AI Assistant Function Malfunctions

• Solution: Check if the API Key is valid and confirm that the AI functions of the Virtuoso database are enabled.

🤝 Contribution Guidelines

Welcome to contribute code or documentation! Please fork this repository and submit a Pull Request to contribute to the development of MCP-JDBC-Server.