README
🚀 OracleDB MCP 服务器
本项目所搭建的 MCP - 模型上下文协议服务器,能将配置好的 Oracle 数据库表及字段,作为上下文提供给大语言模型(LLM)。借助该功能,LLM 可与 Oracle 数据库进行交互,生成 SQL 语句并获取查询结果。
🚀 快速开始
此项目将安装 MCP - 模型上下文协议服务器,借助该服务器,大语言模型(LLM)能够与 Oracle 数据库交互,生成 SQL 语句并返回结果。
✨ 主要特性
- 为大语言模型(LLM)提供 Oracle 数据库表/字段作为上下文。
- 支持 LLM 与 Oracle 数据库交互,生成并执行 SQL 语句。
📦 安装指南
安装包
pip install oracledb_mcp_server
创建 .env 文件
创建包含最小值 Oracle DB 连接字符串 的 .env 文件。示例文件可在此处下载:此处
测试服务器
使用以下命令测试 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 许可证的条款进行许可。
🎥 演示

微信扫一扫