README
🚀 MCP - JDBC - Server
MCP - JDBC - Server 是一个实现了 Model Context Protocol (MCP) 的项目,它支持通过 JDBC 接口进行数据库操作,还集成了 AI 助手功能。该项目能帮助用户更便捷地与数据库交互,特别是在使用 Virtuoso 数据库时,可发挥其特定功能优势。
🚀 快速开始
MCP - JDBC - Server 是一个实现了 Model Context Protocol (MCP) 的项目,支持通过 JDBC 接口进行数据库操作以及集成 AI 助手功能。下面为你介绍如何快速开启使用。
📦 安装指南
1. 下载 MCP - JDBC - Server
从 GitHub 下载最新版本的 MCP - JDBC - Server,并解压到本地目录。
2. 安装依赖
确保已安装以下软件:
- JDK 8 或更高版本:用于运行 Java 程序。
- Maven:用于管理项目依赖和构建。
- Node.js 和 npm:用于运行 MCP 组件(如 Inspector)。
3. 配置环境变量
设置以下环境变量以确保项目顺利运行:
- JAVA_HOME:指向 JDK 的安装目录。
- PATH:包含 Node.js 和 Maven 的可执行文件路径。
💻 使用示例
基础用法
1. 启动 MCP - JDBC - Server
在终端中运行以下命令启动服务器:
java -jar mcp-jdbc-server-1.0.0-runner.jar
2. 配置数据库连接
编辑 config.properties 文件,配置数据库连接信息(如 JDBC URL、用户名和密码)。
3. 使用 MCP 组件
通过以下命令安装并运行 MCP Inspector 进行调试:
npm install -g @modelcontextprotocol/inspector
npx @modelcontextprotocol/inspector java -jar mcp-jdbc-server-1.0.0-runner.jar
访问提供的 URL 地址,即可查看服务器交互信息。
代码示例
基本 JDBC 操作
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();
}
}
}
AI 助手调用
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();
}
}
}
✨ 主要特性
数据库操作
MCP - JDBC - Server 提供标准的 SQL 操作功能,包括:
- 查询数据:执行 SELECT 语句并返回结果。
- 更新数据:执行 INSERT、UPDATE 和 DELETE 语句。
- 事务管理:支持显式事务控制。
AI 助手集成
通过 Virtuoso 数据库的特定函数,MCP - JDBC - Server 集成了 AI 助手功能:
- SPASQL 查询:混合 SQL 和 SPARQL 进行复杂数据分析。
- SPARQL 支持:直接执行 SPARQL 语句并获取结果。
- AI 支持:利用 Virtuoso 的 AI 助手函数,通过 API Key 提供智能查询功能。
📚 详细文档
常见问题
1. 无法启动服务器
- 解决方法:检查环境变量配置是否正确,确保 JDK 和 Maven 已正确安装。
2. 数据库连接失败
- 解决方法:验证数据库 URL、用户名和密码是否正确,并确保数据库服务已运行。
3. AI 助手功能异常
- 解决方法:检查 API Key 是否有效,并确认 Virtuoso 数据库的 AI 函数已启用。
贡献指南
欢迎贡献代码或文档!请 Fork 本仓库并提交 Pull Request,为 MCP - JDBC - Server 的发展贡献力量。
Scan to contact