README
🚀 OracleDB MCP 服务器
该项目主要用于安装 MCP - Model Context Protocol Server,此服务器会将配置好的 Oracle 数据库表/列作为上下文提供给大语言模型(LLM)使用。借助该项目,LLM 能够与 Oracle 数据库进行交互,生成 SQL 语句并返回查询结果。
🚀 快速开始
本项目可以让大语言模型与 Oracle 数据库交互,下面为你介绍如何快速开启使用。
✨ 主要特性
- 安装
MCP - Model Context Protocol Server,为大语言模型提供 Oracle 数据库上下文。 - 支持大语言模型与 Oracle 数据库交互,生成 SQL 语句并返回结果。
📦 安装指南
安装包
pip install oracledb_mcp_server
配置环境文件
创建包含最小值的 Oracle DB Connection String 的 .env 文件。示例文件可在此处下载 here
测试服务器
使用以下命令测试 oracledb_mcp_server 服务器:uv run oracledb_mcp_server,从上述文件夹运行。
💻 使用示例
Claud Desktop 配置
Claud Desktop 的配置详细信息如下:
{
"mcpServers": {
"oracledb_mcp_server":{
"command": "uv",
"args": ["run","oracledb_mcp_server"],
"env": {
"DEBUG":"True",
"COMMENT_DB_CONNECTION_STRING":"oracle+oracledb://USERNAME:PASSWORD@IP:PORT/?service_name=SERVICENAME",
"DB_CONNECTION_STRING":"oracle+oracledb://USERNAME:PASSWORD@IP:PORT/?service_name=SERVICENAME",
"TABLE_WHITE_LIST":"ACCOUNTS,CUS_ACC_RELATIONS,CUSTOMERS",
"COLUMN_WHITE_LIST":"ACCOUNTS.ACC_AAD_ID,CUS_ACC_RELATIONS.CAR_CUS_ID,CUS_ACC_RELATIONS.CAR_AAD_ID,CUSTOMERS.CUS_ID"
}
}
}
}
配置说明
可用环境变量列表:
| 属性 | 详情 |
|------|------|
| DEBUG | 启用调试日志记录(可选,默认为 False) |
| COMMENT_DB_CONNECTION_STRING | 用于评论的 Oracle 数据库连接字符串(必需) |
| DB_CONNECTION_STRING | 用于执行查询的 Oracle 数据库连接字符串(必需) |
| TABLE_WHITE_LIST | 白名单表名列表 ["table1", "table2"](必需) |
| COLUMN_WHITE_LIST | 白名单表 - 列名列表 ["table.column1", "table.column2"](必需) |
| QUERY_LIMIT_SIZE | 默认值为 10 条记录,如果未提供则使用默认值(可选,默认为 10) |
拦截器使用
npx @modelcontextprotocol/inspector uv --directory "D:\\MyDev\\mcp\\oracledb_mcp_server" run -m oracledb_mcp_server
🤝 贡献
欢迎大家参与项目贡献。如果你有好的想法或改进, 请随意提交 Pull Request。
📄 许可证
该项目在 MIT 许可证条款下授权。
🎥 演示

Scan to contact