Skip to content

Commit 27b577f

Browse files
Merge pull request #16 from danielmeppiel/crazyyanchao/main
Consolidate readmes
2 parents 1a77060 + d32afd4 commit 27b577f

File tree

2 files changed

+28
-10
lines changed

2 files changed

+28
-10
lines changed

README-zh.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# MCP 服务器 - Oracle 数据库上下文
22

3+
[English](README.md) | [中文](README-zh.md)
4+
35
一个强大的模型上下文协议(MCP)服务器,为大型 Oracle 数据库提供上下文数据库模式信息,使 AI 助手能够理解和操作包含数千张表的数据库。
46

57
## 目录
@@ -101,7 +103,8 @@ MCP Oracle DB Context 服务器解决了在处理超大型 Oracle 数据库时
101103
"ORACLE_CONNECTION_STRING":"<db-username>/${input:db-password}@<host>:1521/<service-name>",
102104
"TARGET_SCHEMA":"",
103105
"CACHE_DIR":".cache",
104-
"THICK_MODE":"" // 可选:设置为 "1" 以启用 thick 模式
106+
"THICK_MODE":"", // 可选:设置为 "1" 以启用 thick 模式
107+
"ORACLE_CLIENT_LIB_DIR":"" // 可选:如果使用 thick 模式并且想要设置非默认的客户端库目录
105108
}
106109
}
107110
}
@@ -111,6 +114,7 @@ MCP Oracle DB Context 服务器解决了在处理超大型 Oracle 数据库时
111114
使用 Docker(推荐方式):
112115
- 所有依赖项都包含在容器中
113116
- 如需启用 thick 模式,在环境变量中设置 `THICK_MODE=1`
117+
- 如果使用 `THICK_MODE`,可以通过 `ORACLE_CLIENT_LIB_DIR` 来设置 Oracle 客户端库的安装路径(如果与默认位置不同)
114118

115119
#### 选项 2:使用 UV(本地安装)
116120

@@ -174,7 +178,8 @@ MCP Oracle DB Context 服务器解决了在处理超大型 Oracle 数据库时
174178
"ORACLE_CONNECTION_STRING":"<db-username>/${input:db-password}@<host>:1521/<service-name>",
175179
"TARGET_SCHEMA":"",
176180
"CACHE_DIR":".cache",
177-
"THICK_MODE":"" // 可选:设置为 "1" 以启用 thick 模式
181+
"THICK_MODE":"", // 可选:设置为 "1" 以启用 thick 模式
182+
"ORACLE_CLIENT_LIB_DIR":"" // 可选:如果使用 thick 模式并且想要设置非默认的客户端库目录
178183
}
179184
}
180185
}
@@ -193,8 +198,6 @@ MCP Oracle DB Context 服务器解决了在处理超大型 Oracle 数据库时
193198

194199
```bash
195200
uv run main.py
196-
# Reference: uv run --python D:\oracle-mcp-server\.venv\Scripts\python.exe --with mcp[cli] mcp run D:\oracle-mcp-server\main.py
197-
# Reference By Supergateway: npx -y supergateway --stdio "uv run main.py" --port 8000 --baseUrl http://localhost:8000 --ssePath /sse --messagePath /message (Subscribe to events: GET http://localhost:8000/sse;Send messages: POST http://localhost:8000/message)
198201
```
199202

200203
开发和测试:
@@ -339,6 +342,12 @@ ORDERS 表与哪些表有关联?
339342
- 使用 Docker(推荐):在 Docker 环境变量中设置 `THICK_MODE=1`
340343
- 本地安装时:导出 `THICK_MODE=1` 环境变量,并确保已安装与系统架构和数据库版本兼容的 Oracle Client 库
341344
345+
您可以使用 `ORACLE_CLIENT_LIB_DIR` 环境变量指定 Oracle Client 库的自定义位置。这在以下情况下特别有用:
346+
- Oracle Client 库安装在非标准位置
347+
- 需要在同一系统上使用多个 Oracle Client 版本
348+
- 没有管理员权限将 Oracle Client 安装在标准位置
349+
- 需要特定的 Oracle Client 版本以兼容某些数据库功能
350+
342351
注意:使用 Docker 时无需担心 Oracle Client 库的安装,容器已包含(Oracle Instant Client v23.7)。该容器支持 19c 至 23ai 版本的 Oracle 数据库,兼容 linux/arm64 和 linux/amd64 架构。
343352
344353
## 系统要求
@@ -358,7 +367,7 @@ ORDERS 表与哪些表有关联?
358367
359368
## 贡献
360369
361-
欢迎贡献!详情请参阅我们的 [贡献指南](CONTRIBUTING.md)。
370+
我们欢迎贡献!请参阅我们的 [贡献指南](CONTRIBUTING.md) 获取详细信息
362371
363372
## 许可证
364373

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# MCP Server - Oracle DB Context
22

3+
[English](README.md) | [中文](README-zh.md)
4+
35
A powerful Model Context Protocol (MCP) server that provides contextual database schema information for large Oracle databases, enabling AI assistants to understand and work with databases containing thousands of tables.
46

57
## Table of Contents
@@ -101,7 +103,8 @@ In VSCode Insiders, go to your user or workspace `settings.json` file and add th
101103
"ORACLE_CONNECTION_STRING":"<db-username>/${input:db-password}@<host>:1521/<service-name>",
102104
"TARGET_SCHEMA":"",
103105
"CACHE_DIR":".cache",
104-
"THICK_MODE":"" // Optional: set to "1" to enable thick mode
106+
"THICK_MODE":"", // Optional: set to "1" to enable thick mode
107+
"ORACLE_CLIENT_LIB_DIR":"" // Optional: in case you use thick mode and you want to set a non-default directory for client libraries
105108
}
106109
}
107110
}
@@ -111,6 +114,7 @@ In VSCode Insiders, go to your user or workspace `settings.json` file and add th
111114
When using Docker (recommended approach):
112115
- All dependencies are included in the container
113116
- Set `THICK_MODE=1` in the environment variables to enable thick mode if needed
117+
- If you use `THICK_MODE`, you can optionally set the path where Oracle Client libraries are installed with `ORACLE_CLIENT_LIB_DIR` if it differs from the default location.
114118

115119
#### Option 2: Using UV (Local Installation)
116120

@@ -174,7 +178,8 @@ In VSCode Insiders, go to your user or workspace `settings.json` file and add th
174178
"ORACLE_CONNECTION_STRING":"<db-username>/${input:db-password}@<host>:1521/<service-name>",
175179
"TARGET_SCHEMA":"",
176180
"CACHE_DIR":".cache",
177-
"THICK_MODE":"" // Optional: set to "1" to enable thick mode
181+
"THICK_MODE":"", // Optional: set to "1" to enable thick mode
182+
"ORACLE_CLIENT_LIB_DIR":"" // Optional: in case you use thick mode and if you want to set a non-default directory for client libraries
178183
}
179184
}
180185
}
@@ -193,8 +198,6 @@ To run the MCP server directly:
193198
194199
```bash
195200
uv run main.py
196-
# Reference: uv run --python D:\oracle-mcp-server\.venv\Scripts\python.exe --with mcp[cli] mcp run D:\oracle-mcp-server\main.py
197-
# Reference By Supergateway: npx -y supergateway --stdio "uv run main.py" --port 8000 --baseUrl http://localhost:8000 --ssePath /sse --messagePath /message (Subscribe to events: GET http://localhost:8000/sse;Send messages: POST http://localhost:8000/message)
198201
```
199202
200203
For development and testing:
@@ -339,7 +342,13 @@ For scenarios requiring advanced Oracle features or better performance, you can
339342
- When using Docker (recommended): Set `THICK_MODE=1` in the Docker environment variables
340343
- When using local installation: Export `THICK_MODE=1` environment variable and ensure Oracle Client libraries, compatible with your system architecture and database version, are installed
341344
342-
Note: When using Docker, you don't need to worry about installing Oracle Client libraries as they are included in the container (Oracle Instant Client v23.7). The container supports Oracle databases versions 19c up to 23ai in both linux/arm64 and linux/amd64 architectures.
345+
You can specify a custom location for the Oracle Client libraries using the `ORACLE_CLIENT_LIB_DIR` environment variable. This is particularly useful when:
346+
- You have Oracle Client libraries installed in non-standard locations
347+
- You need to work with multiple Oracle Client versions on the same system
348+
- You don't have administrative privileges to install Oracle Client in standard locations
349+
- You need specific Oracle Client versions for compatibility with certain database features
350+
351+
Note: When using Docker, you don't need to worry about installing Oracle Client libraries as they are included in the container (Oracle Instant Client v23.7). The container supports Oracle databases versions 19c up to 23ai in both linux/arm64 and linux/amd64 architectures.
343352
344353
## System Requirements
345354

0 commit comments

Comments
 (0)