Jdbc MCP

🚀 JDBC-MCP Project Documentation

JDBC-MCP is an MCP (Machine Learning Platform) server built on the Quarkus framework, primarily used for handling database-related operations. It supports multiple database types and interacts with databases via the JDBC protocol. This project is a branch of the Quarkus MCP server, adding Docker deployment capabilities and enhanced security features.

✨ Features

Docker Deployment

JDBC-MCP can now be deployed in a Docker container, simplifying the installation and configuration process. Users can quickly start and run the service according to the examples in the documentation.

MCP SSE (Server-Sent Events)

MCP SSE supports real-time data transfer through Server-Sent Events. Here is an example using Docker:

docker run -e jdbc.url=jdbc:mysql://localhost:3306/mydb \
          -e jdbc.user=root \
          -e jdbc.password=secret \
          -e enable.write.sql=false \
          quarkus-mcp-jdbc:latest

MCP STDIO

MCP STDIO provides the ability to interact through standard input and output. Users can configure environment variables as needed.

📦 Installation

Environment Variables

🔧 Technical Details

Security Precautions

• By default, write SQL operations (such as INSERT, UPDATE, DELETE) are disabled.
• Users can set the environment variable enable.write.sql=true to enable write functionality as needed.

Best Practices

1. Use a read-only database user.
2. Configure network-level access control.
3. When running the service in a production environment, it is recommended to use an isolated network environment.

📚 Documentation

Integration with LLM

JDBC-MCP provides a standard API that allows large language models to interact with the database through the MCP server endpoint. The specific steps are as follows:

1. Configure the LLM to use the MCP server address.
2. Define the required permissions (read-only or read-write).
3. Ensure that the database schema is visible to the MCP server.

Original Documentation

For more detailed information, please refer to the original project documentation: Quarkus MCP JDBC Server

📄 License

This project is licensed under the Apache License 2.0.

Acknowledgments

• Original project: Quarkiverse MCP Servers
• Built with the Quarkus framework
• Containerization technology supported by Docker