Skip to content

Commit de79e88

Browse files
committed
docs: document NL2SQL and Hosted Deployment env vars
Adds NEXT_PUBLIC_NL2SQL_MCP_URL and APPLICATION_BASE_URL to the asset README, in line with the v0.9.7 and v0.9.8 features. Removes the "coming soon" tag from Text-to-SQL and drops the stale SDD Generator example from the MCP tool invocation note.
1 parent dc5bf39 commit de79e88

1 file changed

Lines changed: 15 additions & 3 deletions

File tree

  • ai/gen-ai-agents/oci-enterprise-ai-chat

ai/gen-ai-agents/oci-enterprise-ai-chat/README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,18 @@ LANGFUSE_BASE_URL=https://cloud.langfuse.com
7373
LOG_LEVEL=info
7474
```
7575

76+
### Text-to-SQL via MCP, optional
77+
78+
```env
79+
NEXT_PUBLIC_NL2SQL_MCP_URL=https://your-nl2sql-mcp.example.com/mcp
80+
```
81+
82+
When set, points the in-chat Text-to-SQL flow at a hosted DBTools MCP server that exposes `generate_sql`. When unset, the Text-to-SQL toggle stays hidden.
83+
84+
### OCI Generative AI Hosted Deployments, optional
85+
86+
When the app is deployed via OCI Generative AI Hosted Applications, the platform injects `APPLICATION_BASE_URL` (the full invocation prefix) into the container. `entrypoint.sh` honors it automatically and falls back to a manual `BASE_PATH=/your-path` for non-hosted deployments behind a subpath. Nothing to set if you do not use either.
87+
7688
### Models
7789

7890
Models are defined as a static list in `src/app/page.js` (`STATIC_MODELS`). To add or remove a model available in your tenancy, edit that array. No env var needed.
@@ -113,7 +125,7 @@ Toggle per-tool from Settings → Tools → Native:
113125
- **Web Search** *(coming soon)*, real-time web lookups
114126
- **File Search (RAG)**: vector retrieval over Knowledge Bases
115127
- **Code Interpreter**: Python sandbox with 420+ libraries
116-
- **Text-to-SQL** *(coming soon)*, natural language SQL against your semantic stores
128+
- **Text-to-SQL**: natural language to SQL against your semantic stores, fronted by a hosted DBTools MCP server (set `NEXT_PUBLIC_NL2SQL_MCP_URL` in [Configuration](#text-to-sql-via-mcp-optional))
117129

118130
![Tools settings](images/03-settings-tools.png)
119131

@@ -245,7 +257,7 @@ src/
245257

246258
### MCP tool invocation
247259
1. OCI executes MCP tools natively via the Responses API. The app **does not run tools itself** during chat (only for Test Connection / Refresh in Settings).
248-
2. For OAuth 2.1 MCP servers (e.g. SDD Generator), the client obtains an access token via `/api/mcp/oauth/*` and passes it to OCI in the tool's `authorization` field
260+
2. For OAuth 2.1 MCP servers, the client obtains an access token via `/api/mcp/oauth/*` and passes it to OCI in the tool's `authorization` field
249261
3. Custom servers use the more generic `/api/mcp` JSON-RPC proxy for discovery and direct invocation (outside OCI)
250262

251263
### Settings persistence
@@ -355,7 +367,7 @@ oci container-instances container-instance restart \
355367

356368
### Notes
357369
- A `/ready` healthcheck endpoint is exposed for the LB.
358-
- If you mount the app under a subpath, set `BASE_PATH=/your-path`.
370+
- For subpath deployments, set `BASE_PATH=/your-path`. On OCI Generative AI Hosted Deployments the platform injects `APPLICATION_BASE_URL` automatically and `entrypoint.sh` honors it (falling back to `BASE_PATH` otherwise).
359371
- When the LB-to-backend connection is HTTP (not HTTPS end-to-end), cookies must **not** carry the `Secure` flag. `mcp-oauth.js` and the IDCS auth code already handle this automatically when running over HTTP.
360372
- All secrets (Client Secret, Session Secret, Langfuse keys) should be set as **environment variables on the Container Instance**, never baked into the image.
361373

0 commit comments

Comments
 (0)