Governed, least-privilege Oracle Database access for AI agents — in pure Rust.
oraclemcp is a Model Context Protocol server that gives an AI agent governed, least-privilege access to an Oracle database: schema introspection, DDL, compile errors, source search, ad-hoc read queries, plan analysis, and an explicit profile-gated execution path for non-read SQL. Every raw statement the agent submits is classified before it can reach Oracle. Read tools only admit statements proven read-only; oracle_execute only runs statements permitted by the active profile/session level, rolls DML back by default, and requires a preview-derived execution grant before commit. Session elevation is explicit, temporary, and capped by profile max_level. The core is engine-free and #![forbid(unsafe_code)].
An independent open-source project; not affiliated with Oracle. For Oracle's own MCP servers, see oracle/mcp.
Install, service, dashboard
One line installs or updates oraclemcp on macOS and Linux. It works as pasted
for a human terminal and for a non-interactive agent run:
curl -fsSL "https://raw.githubusercontent.com/MuhDur/oraclemcp/main/install.sh?$(date +%s)" | bash
The hosted script fetch includes a cache buster so stale CDN/proxy copies do not
hide installer updates. This command installs the latest published release; add
--version X.Y.Z (or vX.Y.Z) to pin a specific release instead. Later
examples that contain ..., <pw>, <profile>, or placeholder env values are
templates: replace those placeholders before running them.
The normal command downloads, verifies, and installs into $HOME/.local unless
you pass --prefix. It requires the SHA-256 digest check, verifies the cosign
blob signature and provenance attestation when cosign is installed, and installs
oraclemcp plus the short om alias. Missing cosign is a visible
authenticity-unverified posture by default; use --verify require when your
environment requires cosign to be present.
In an interactive terminal, the installer then offers a short guided flow:
append the binary directory to PATH, run doctor, offer zero-config database
discovery from tnsnames.ora, print an MCP client snippet, and optionally
install the loopback service. In a pipe, CI job, or agent run, it never prompts,
never scans, and never starts a service; it installs the binary and prints the
exact PATH line plus next steps on stderr. Every install finishes with next
steps on stderr: discover databases, run doctor, write the starter profile,
and generate MCP client snippets.
Get started in minutes: zero-config onboarding
oraclemcp setup --discover finds every database defined in your tnsnames.ora
and writes one read-only connection profile per net-service — through the
same governed config-ops path (timestamped backup, atomic write, strict
re-validation) used everywhere else. It is consent-gated: an interactive run
asks before it scans and again before it writes; a non-interactive run without
--discover-tns (or --yes) refuses with exit code 2 and scans nothing. It
writes no secrets to disk (each profile references an environment variable,
env:ORACLE_<NAME>_PASSWORD, that you export yourself), keeps every profile
capped at READ_ONLY, and is idempotent and non-destructive: existing
profiles and hand edits are preserved, only new databases are added. When no
tnsnames.ora is found it falls back to the minimal starter profile so you
still boot. Add
--json for a names-only agent report, or --dry-run to preview without
writing. Run oraclemcp doctor afterwards to see exactly which credentials
remain to be set. Full contract: docs/tns-discovery-onboarding.md.
Re-running the same one-liner is the update path. Re-running the same verified
archive is a no-op for identical installed files; re-running with a newer target
updates atomically after backing up the previous binary. A downgrade is refused unless you pass --force.
Historical 0.8.0 operator notes (the coordinated 0.9.0 equivalents are tracked
separately):
docs/upgrading-to-0.8.0.md,
docs/downgrading-0.8.0-to-0.7.2.md,
and docs/feature-rollout-0.8.0.md.
Use the dry-run command first when you want a preview: it prints the archive, verification inputs, files, service plan, client-registration plan, and installer lock path, then exits before downloading, verifying, writing files, or touching the service manager. Dry-run exists for review and automation plans; the normal command above is the install/update command.
Advanced install paths
Preview the Linux/macOS host plan without changing the machine:
curl -fsSL "https://raw.githubusercontent.com/MuhDur/oraclemcp/main/install.sh?$(date +%s)" | bash -s -- --dry-run
From an installed binary, preview or run the same update path:
oraclemcp --json self-update --dry-run
oraclemcp self-update --no-service
On Windows, download and run the PowerShell installer:
iwr -UseBasicParsing https://raw.githubusercontent.com/MuhDur/oraclemcp/main/install.ps1 -OutFile install.ps1
powershell -ExecutionPolicy Bypass -File .\install.ps1 -DryRun
powershell -ExecutionPolicy Bypass -File .\install.ps1
The Windows installer accepts the same release operations: -Update for the
explicit update path, -NoService to suppress service prompts, and
-Verify prefer, -Verify require, or -Verify checksum-only for the
verification posture. prefer installs after a hard SHA-256 check when cosign
is missing; require fails without cosign.
powershell -ExecutionPolicy Bypass -File .\install.ps1 -Update -NoService
For air-gapped hosts, download the release archive plus its .sha256, .sig,
.crt, and .attestation.sigstore.json siblings, then run a downloaded copy
of the installer:
bash install.sh --offline ./oraclemcp-x86_64-unknown-linux-musl.tar.gz --version 0.9.0
powershell -ExecutionPolicy Bypass -File .\install.ps1 `
-Offline .\oraclemcp-x86_64-pc-windows-msvc.zip -Version 0.9.0
Historical 0.8.0 offline examples used -Version 0.8.0; use 0.9.0 for the
current release above.
The corresponding historical invocations were
bash install.sh --offline ./oraclemcp-x86_64-unknown-linux-musl.tar.gz --version 0.8.0
and -Offline .\oraclemcp-x86_64-pc-windows-msvc.zip -Version 0.8.0.
The release installer does not silently fall back from a missing release archive
to a source build. Use --source explicitly when you want cargo install
instead of the verified archive path.
On Linux the installer auto-detects the static musl build, which runs everywhere
(including WSL2). The published glibc tarballs are also installable, but only by
explicit request: --target x86_64-unknown-linux-gnu (or
aarch64-unknown-linux-gnu).
Uninstall is preview-first and idempotent. Service removal remains an explicit service-manager mutation:
bash install.sh --uninstall --dry-run
bash install.sh --uninstall --yes
bash install.sh --uninstall --service --yes
powershell -ExecutionPolicy Bypass -File .\install.ps1 -Uninstall -DryRun
powershell -ExecutionPolicy Bypass -File .\install.ps1 -Uninstall -Yes
Install the local service only with explicit consent. Keep it on loopback unless you deliberately configure remote HTTP, and use service-owned client credentials, OAuth, or mTLS for HTTP MCP clients. For Windows service install, the PowerShell installer also requires explicit consent.
oraclemcp --json service install --dry-run --profile db_ro --listen 127.0.0.1:7070 --client-credentials
oraclemcp service install --yes --profile db_ro --listen 127.0.0.1:7070 --client-credentials
oraclemcp --json clients issue --label claude --scope oracle:read
powershell -ExecutionPolicy Bypass -File .\install.ps1 -Service -Yes -Profile db_ro
Request a listener-bound pairing URL plus a one-time code, open the printed URL, and paste the code into the form it serves:
om dashboard
The printed URL carries no secret, so it is safe in browser history, in a
Referer, and in the view of any extension holding tabs/webNavigation
permission. The one-time code is accepted only from the pairing form's POST body
— never from a URL query or fragment — and the CLI never hands either to a
desktop launcher (where process argv could expose it). The dashboard uses a
one-time loopback pairing ticket bound to the exact live listener instance and
scheme/host/port, then an HttpOnly, SameSite=Strict cookie plus CSRF and
route-scoped action tickets. The cookie is
Secure under native TLS or explicit trusted HTTPS termination; the only
non-Secure exception is server-observed loopback HTTP, and remote plaintext
requests never receive privileged browser cookies. Browser
requests do not supply the database Subject: the server derives the Subject from
the authenticated transport principal, session, and lane context. Authenticated
HTTP sessions run on isolated per-principal lanes with their own Oracle
connection, operating level, grants, cancellation, and audit context. Intentional
--allow-no-auth HTTP development uses one anonymous lane; stdio remains the
single local client path.
Other release channels come from the same signed archive matrix. These channels can lag the GitHub release tag, so use the check command first and install only after it resolves the target version.
cargo binstall oraclemcp
docker run -i --rm ghcr.io/muhdur/oraclemcp:latest
Pending registry-backed channels:
brew info MuhDur/oraclemcp/oraclemcp
winget search --id MuhDur.oraclemcp --exact
After the relevant check resolves the target version, these commands are copy-pasteable:
brew install MuhDur/oraclemcp/oraclemcp
winget install --id MuhDur.oraclemcp --exact
An npm/npx channel is not offered. Install with the one-line installer above, or
cargo binstall oraclemcp, the GHCR Docker image, or the Homebrew/winget
channels once they resolve.
Why oraclemcp
- Fail-closed by construction. A SELECT that an agent dreams up should never silently turn into a
DELETE. Each raw statement runs through the hardened classifier. Read tools admit only proven read-onlySELECT/WITHand dictionary introspection. Non-read execution is isolated inoracle_execute, bounded by profilemax_level/default_level, rollback-by-default for DML, and explicit-confirm-before-commit. Temporary elevation throughoracle_set_session_levelcan never exceed the profile ceiling. Forbidden constructs (multi-statement batches, string-concat dynamic SQL, an unproven function call inside a SELECT) are rejected before touching the database, with anOperatingLevelTooLoworForbiddenStatementenvelope and a suggested safe alternative. - Agent-first UX. Every tool ships a real JSON Schema, title, and explicit MCP annotations (
readOnlyHint,destructiveHint,idempotentHint,openWorldHint) so clients do not infer unsafe defaults. Errors are structuredErrorEnvelopes with machine-stable classes, fuzzy suggestions, and next-step hints, not bare strings. A zero-argoracle_capabilitiestool lets an agent discover the surface; MCP resources expose the capability/tool documents plus schema/object read templates; and an offline build degrades to aRuntimeStateRequiredcontract instead of crashing. - Pure Rust, no
unsafe. Every crate is#![forbid(unsafe_code)]; the fail-closed classifier carries a differential cargo-fuzz target. - Two transports. stdio (default) and Streamable HTTP (
--listen) with fail-closed auth defaults, optional OAuth bearer enforcement, and native rustls TLS/mTLS.
Source builds and runtime requirements
This branch is pinned to nightly-2026-05-11 and has no stable MSRV. The
pin is required, for two independent reasons: this checkout resolves
asupersync 0.3.9, whose
nightly-outcome-try feature enables #![feature(try_trait_v2)] and
try_trait_v2_residual inside asupersync (it is opt-in, but in asupersync's
default feature set, and reaches us through the oracledb dependency), and on
Windows oraclemcp-core additionally needs windows_by_handle. The pinned
oracledb 0.8.4 driver's own source is stable-clean — it is its asupersync
dependency declaration that pulls the nightly feature in.
docs/TOOLCHAIN.md has the exact mechanism. The
repository's rust-toolchain.toml selects the pin for local builds. Use the release installer above when you want
the prebuilt binary; use cargo install only when you intentionally want a
source build.
rustup toolchain install nightly-2026-05-11 --component rustfmt --component clippy
Direct source install:
cargo +nightly-2026-05-11 install oraclemcp
Live database access is built in through the pure-Rust thin oracledb driver.
Runtime requirements for live database access:
- Optionally
TNS_ADMINpointing at a directory withtnsnames.oraif you connect by net-service name.
No Oracle Instant Client, ODPI-C library, or C toolchain is required by the driver.
Use oraclemcp --json doctor to verify the binary and offline setup,
oraclemcp --json doctor --profile <profile> to inspect non-secret profile
metadata without resolving secrets, and
oraclemcp --json doctor --online --profile <profile> to add live
connectivity, authentication, role/open-mode, standby, and privilege checks.
Doctor output is safe to paste into agent sessions: it omits connect strings,
usernames, credential_ref values, passwords, proxy identities, wallet
passwords, IAM tokens, wallet paths, and server DNs while keeping structured
failure classes and ORA codes visible.
Generate generic local setup templates for profiles, wrappers, and MCP client snippets:
oraclemcp --json setup --profile db_ro
To create a minimal starter profiles file directly, use the same config-ops backend the dashboard uses. This validates the draft, writes a backup, atomically replaces the target, and reports the reload/rollback metadata without echoing the raw profile TOML:
oraclemcp --json setup --write --profile db_ro
Docker: a ready-to-run thin-driver image, published to GHCR and listed in the MCP registry on release as io.github.MuhDur/oraclemcp. Mount a profiles config and pass the credential the profile's credential_ref expects:
docker run -i --rm \
-v "$HOME/.config/oraclemcp:/root/.config/oraclemcp:ro" \
-e ORACLE_APP_PASSWORD \
ghcr.io/muhdur/oraclemcp:latest # MCP over stdio, against the configured profile
docker run -i --rm ghcr.io/muhdur/oraclemcp:latest # tool surface only (no DB)
An optional PL/SQL intelligence image is available from the manual Docker
workflow. It is the same server compiled with --features plsql-intelligence;
it can start without a database connection and advertises the offline
oracle_plsql_* tools immediately. Live PL/SQL tools still require a profile.
docker run -i --rm ghcr.io/muhdur/oraclemcp:plsql-intelligence-latest --json info
docker run -i --rm ghcr.io/muhdur/oraclemcp:plsql-intelligence-latest capabilities
Local feature-image builds resolve the PL/SQL engine crates from crates.io:
docker buildx build \
--target runtime-plsql-intelligence \
-t oraclemcp:plsql-intelligence .
docker run -i --rm oraclemcp:plsql-intelligence --json info
The Docker image and crates are Apache-2.0 OR MIT and do not redistribute Oracle Instant Client.
Wire it into an MCP client (e.g. Claude Desktop) over stdio:
{
"mcpServers": {
"oracle": {
"command": "oraclemcp",
"args": ["serve", "--profile", "db_ro", "--allow-no-auth"]
}
}
}
For Codex-style TOML config, the same command is:
[mcp_servers.oracle]
command = "oraclemcp"
args = ["serve", "--profile", "db_ro", "--allow-no-auth"]
Or run it directly:
oraclemcp serve # stdio (default); --allow-no-auth for local dev
oraclemcp --json clients issue --label claude --scope oracle:read # shown-once HTTP bearer
oraclemcp serve --listen 127.0.0.1:7070 --client-credentials --profile db_ro
oraclemcp serve --listen 127.0.0.1:7070 --allow-no-auth # local HTTP dev only
oraclemcp --json setup --profile db_ro # generic onboarding templates
oraclemcp --json setup --write --profile db_ro # write starter profiles via SCFG
oraclemcp capabilities # the advertised tool surface + feature tiers (JSON)
oraclemcp --json profiles # configured profile names and non-secret metadata
oraclemcp doctor # offline diagnostics (thin driver, TNS/wallet, classifier, NLS)
oraclemcp doctor --profile dev_ro # inspect profile metadata offline
oraclemcp doctor --online --profile dev_ro # include live connectivity/auth/role/privilege checks
oraclemcp info # build info: version, tools, transports, thin DB
oraclemcp robot-docs guide # compact in-binary guide for agents
oraclemcp completions bash # shell completions: bash, zsh, fish, powershell
oraclemcp --json service install --dry-run --profile db_ro # preview systemd/launchd/Windows service changes
oraclemcp service install --yes --client-credentials --profile db_ro
oraclemcp --json service status # inspect service-manager state
oraclemcp --json service logs # inspect recent service logs
oraclemcp --json service backup --dry-run # preview state+config backup
oraclemcp --json service restore /path/to/backup --dry-run # verify audit chain before restore
oraclemcp dashboard # open the local dashboard through a one-time pairing URL
--json is a visible alias for --robot-json and keeps stdout as a single
machine-readable JSON object.
Stdio init-token clients
ORACLEMCP_STDIO_TOKEN (or serve --stdio-token) enables a handshake token
for a custom MCP client that controls the raw initialize request. The
client must send the shared token as a JSON string at exactly
params._meta["oraclemcp/initToken"]; a missing key or a non-string value is
reported as missing. This is not a generic Claude/Codex-style configuration
snippet: mainstream MCP client configuration surfaces do not provide a way to
inject initialize metadata. If the client cannot control that frame, keep
stdio local and use --allow-no-auth deliberately, or use authenticated HTTP
instead.
Release archives also include om (om.exe on Windows) as an argv0-aware
short alias. om dashboard is equivalent to oraclemcp dashboard and uses the
short name in CLI help and dashboard diagnostics when invoked through that
alias.
oraclemcp service install targets the platform user service manager: systemd
--user on Linux, launchd on macOS, and Windows services on Windows. Mutating
service operations (install, uninstall, restart, backup, restore) require --yes;
--dry-run emits the exact file and command plan without changing the host.
Generated service definitions include bounded host caps for the 64-lane default:
systemd uses Type=notify, NotifyAccess=main, Restart=on-failure,
LimitNOFILE=65536, TasksMax=512, MemoryMax=2G, and
OOMScoreAdjust=100; launchd uses KeepAlive plus file/process
SoftResourceLimits; Windows configures automatic start and restart-on-failure
through sc.exe. oraclemcp --json doctor reports those configured caps plus
the effective open-file, task, memory-cgroup, and OOM caps visible to the
current process. service backup snapshots the XDG service state directory plus
the resolved profiles config into a new manifest directory; service restore
verifies the backed-up audit hash-chain before stopping the service, restoring
files, and starting it again.
Streamable HTTP auth rules are unchanged for service mode: configure
service-owned per-client credentials, OAuth, or mTLS with registered client leaf
fingerprints, or pass --allow-no-auth only for intentional local development.
The HTTP service also owns a private service-instance.json lock in its state
root ($XDG_STATE_HOME/oraclemcp, or $HOME/.local/state/oraclemcp when XDG
is unset). A second serve --listen process using that same state root refuses
to start and reports the existing pid/listen metadata instead of silently
taking over another port or socket. For intentionally independent instances,
give each process a distinct XDG_STATE_HOME and listener port; that also
separates their service-owned credentials, audit records, and durable state.
The browser dashboard is paired separately even on loopback. oraclemcp dashboard creates a 0600 one-time ticket under the user runtime directory and
prints a secret-free /dashboard/pair URL alongside a one-time code. That URL
serves a script-free form; submitting the code POSTs it in the request body, and
the server exchanges it for an HttpOnly, SameSite=Strict dashboard cookie. The
code is never read from the request target — a /dashboard/pair?ticket=... URL
is refused outright without consuming the ticket — so the bootstrap secret
cannot be recovered from browser history, a Referer, an access log, or a
browser extension watching navigations. The cookie is Secure under
native TLS or [http].trusted_https_termination = true; non-Secure cookies are
limited to server-observed loopback HTTP. Forwarded scheme headers are ignored,
and remote plaintext requests do not receive privileged browser cookies. The
ticket expires in 60 seconds
and is single-use; dashboard POSTs also require same-origin headers, a CSRF
token, and a route-scoped action ticket.
The dashboard Workbench is not a terminal or SQL shell. Classify and preview
actions forward to oracle_preview_sql, read execution forwards to
oracle_query, and guarded DML forwards to oracle_execute with the same
single-use confirmation grant and audit path agents use. Browser-originated
DDL/Admin apply is release-gated; DDL can be previewed, but applying it requires
a non-browser operator path until a profile-level dashboard DDL opt-in exists.
When compiled with plsql-intelligence, the Workbench IDE panel also exposes
the static oracle_plsql_parse, oracle_plsql_analyze,
oracle_plsql_lineage, oracle_plsql_sast, oracle_plsql_doc, and
oracle_plsql_what_breaks tools for source navigation, dependency, lint, doc,
and impact previews; live snapshot/blast-radius tools remain outside the
browser allowlist.
The Reviews board stores profile-scoped Change Proposals as service-owned SQL
templates plus captured binds, then applies them by re-classifying each
template and forwarding through the same guarded action route; stored proposal
verdicts are never authorization inputs. For source-replaceable
CREATE OR REPLACE DDL, proposal apply captures the prior source into
content-addressed service files before dispatch when the current source is
visible. /operator/v1/source-history lists source-free snapshot metadata, and
dashboard revert creates a normal DDL Change Proposal from the stored snapshot
instead of bypassing review, confirmation, or profile ceilings.
The Explorer page includes global search across visible schemas: object-name
matches use oracle_search_objects with all object types, and source-text
matches use oracle_search_source; both are sent through the same guarded
operator action route as the rest of the dashboard.
The Reviews page can also compare two supplied schema snapshots and export a
reviewable migration script. The diff view omits raw DDL and shows hashes/counts;
any executable export step must be drafted into the normal Change Proposal board
before apply, where the server re-classifies and re-checks the statement.
The Ground Control CI-lane tile is refreshed outside request handling by one
bounded background poller. It reads the repository's generated scheduled and
advisory lane taxonomy, polls the fixed public GitHub Actions API immediately
and every 30 minutes, and atomically stores a local snapshot. Missing, stale,
contradictory, or unavailable evidence renders unknown, never green. The
separate CI Heartbeat workflow remains the notification path for required-lane
red/unknown transitions; the dashboard does not depend on manually copying its
ephemeral artifact onto the service host.
The Streamable HTTP transport (--listen) fails closed. It starts only when
service-owned per-client credentials, OAuth bearer enforcement, mTLS
client-certificate verification, or --allow-no-auth is supplied, and mTLS
requests become application principals only through registered leaf
fingerprints. It refuses any non-loopback bind unless
ORACLEMCP_HTTP_ALLOW_REMOTE=1 is set. Per-client credentials are one bearer
per MCP client; the bearer is shown once by oraclemcp clients issue or
oraclemcp clients rotate, while clients.json stores only salted hashes:
oraclemcp --json clients issue --label claude --scope oracle:read
oraclemcp serve --listen 127.0.0.1:7070 --client-credentials --profile db_ro
oraclemcp --json clients rotate <client_id>
oraclemcp --json clients revoke <client_id>
OAuth configuration can come from profiles.toml or CLI flags. The resolved
HS256 secret must be at least 32 bytes (256 bits); use randomly generated key
material rather than a password or memorable phrase:
export ORACLEMCP_OAUTH_HS256_SECRET='replace-with-a-long-random-secret'
oraclemcp serve --listen 127.0.0.1:7070 \
--oauth-resource http://127.0.0.1:7070/mcp \
--oauth-issuer https://issuer.example.com \
--oauth-authorization-server https://issuer.example.com \
--oauth-required-scope oracle:read \
--oauth-hs256-secret-ref env:ORACLEMCP_OAUTH_HS256_SECRET \
--http-allowed-host 127.0.0.1:7070 \
--http-allowed-origin https://client.example.com
When OAuth is enabled, /.well-known/oauth-protected-resource stays public,
/mcp requires a valid bearer token, and granted oracle:* scopes lower the
request's effective operating ceiling monotonically. oracle:read caps the
request at READ_ONLY, oracle:write/oracle:execute at READ_WRITE,
oracle:ddl at DDL, and oracle:admin at ADMIN; none of them can raise a
profile above its max_level, and protected profiles remain READ_ONLY.
JWT bearer tokens must use the RFC 9068 access-token profile: the protected
typ header is at+jwt (or application/at+jwt), and iss, sub, aud,
exp, client_id, iat, and jti have their required access-token shapes.
Generic JWTs and OpenID Connect ID tokens are rejected; there is no implicit
generic-JWT compatibility mode.
Native TLS uses rustls when [http.tls] or --tls-cert / --tls-key are
configured. Adding [http.tls.client_ca_path] or --mtls-client-ca requires
client certificates (mTLS) verified against that CA, but a CA-verified cert is
not an application identity until its leaf DER SHA-256 fingerprint is listed in
[http.mtls].client_fingerprints or passed with --mtls-client-fingerprint.
The resulting principal key is mtls:sha256:<hex>. Server-only TLS encrypts the
transport but is not application authentication, so /mcp still needs
per-client credentials, OAuth, or an explicit --allow-no-auth development
opt-in. Non-loopback binds require ORACLEMCP_HTTP_ALLOW_REMOTE=1 even with
TLS. Native TLS on a non-loopback listener emits
Strict-Transport-Security: max-age=31536000; includeSubDomains; loopback
HTTPS deliberately omits HSTS so browser pinning cannot disrupt local HTTP
development.
When Claude Code connects over HTTPS to a self-signed or private-CA listener,
start it with that CA PEM in Node's trust store: NODE_EXTRA_CA_CERTS=/path/to/private-ca.pem claude.
Connection profiles are resolved from layered configuration (oraclemcp-config); select one with serve --profile <name>.
Connection profiles
See also:
oraclemcp.example.tomlis a fully annotated, copy-pasteable config showing every field with its default;docs/configuration.mdis the canonical field reference (types, defaults, precedence, the operating-level ladder, themcp_exposedopt-out, auth modes, andbaseinheritance). Theoraclemcp setup --writestarter is intentionally smaller so it can boot before you add wallet, proxy, DRCP, pool, app-context, or writable-profile settings.
Signed audit and unsigned refusal trail
For live database access, create ~/.config/oraclemcp/profiles.toml:
schema_version = 2
default_profile = "dev_ro"
# Optional least-privilege profile for fleet-wide DB observability.
# monitor_profile = "monitor_ro"
[http]
allowed_hosts = ["127.0.0.1:7070"]
allowed_origins = ["https://client.example.com"]
json_response = true
stateful = false
dashboard_workbench = false
[http.oauth]
resource = "http://127.0.0.1:7070/mcp"
allowed_issuers = ["https://issuer.example.com"]
authorization_servers = ["https://issuer.example.com"]
required_scopes = ["oracle:read"]
hs256_secret_ref = "env:ORACLEMCP_OAUTH_HS256_SECRET"
# Optional native HTTPS / mTLS listener.
# [http.tls]
# cert_chain_path = "/path/to/server-chain.pem"
# private_key_path = "/path/to/server-key.pem"
# client_ca_path = "/path/to/client-ca.pem" # require mTLS client certs
#
# [http.mtls]
# client_fingerprints = ["sha256:<client-leaf-der-sha256>"]
#
# Optional dedicated remote incident-response ingress. This is a second,
# separately bounded listener; it is mandatory-mTLS and accepts only registered
# certificates. The same fingerprint must also be allow-listed as an operator.
# [http.control]
# listen = "0.0.0.0:7071"
# preauth_workers = 4
# operator_workers = 1
# doctor_workers = 1
#
# [http.operator]
# allow_loopback_owner = true
# allowed_subjects = ["mtls:sha256:<client-leaf-der-sha256>"]
# Signed audit chain. It records every privileged action in an append-only,
# hash-chained, HMAC-SHA256-signed JSONL stream. Omit `path` to use
# $XDG_STATE_HOME/oraclemcp/audit/audit.jsonl (or
# $HOME/.local/state/oraclemcp/audit/audit.jsonl when XDG_STATE_HOME is unset).
[audit]
path = "/var/lib/oraclemcp/audit/audit.jsonl"
# `key_ref` resolves through SecretResolver (env:, file:, or keyring:); its
# resolved value must be at least 32 bytes of independently random material.
key_ref = "env:ORACLEMCP_AUDIT_KEY"
key_id = "2026-q3"
# Retain old verification-only keys during rotation.
# [[audit.verification_keys]]
# key_id = "2026-q2"
# key_ref = "env:ORACLEMCP_AUDIT_KEY_2026_Q2"
# When no signed auditor exists because every reachable profile is READ_ONLY,
# this separate redacted refusal/security-event floor is on by default at
# $XDG_STATE_HOME/oraclemcp/corpus/refusals.jsonl. It is unsigned and not
# tamper-evident; it never replaces the signed chain. Set false only to opt out.
unsigned_refusal_log = true
[[profiles]]
name = "dev_ro"
description = "Read-only development database"
connect_string = "localhost:1521/FREEPDB1"
username = "APP_READONLY"
credential_ref = "env:ORACLE_APP_PASSWORD"
max_level = "READ_ONLY"
default_level = "READ_ONLY"
require_signed_tools = true
dashboard_ddl_workbench = false
# Optional Oracle call timeout and request-budget ceiling. Omit for the 30s
# default; set 0 only to opt out deliberately. Tool calls can tighten it with
# timeout_seconds where advertised.
call_timeout_seconds = 30
# Optional thin Session Data Unit request. Validated as 512..=65535 bytes.
sdu = 32768
login_statements = [
"ALTER SESSION SET NLS_LANGUAGE = english",
"ALTER SESSION SET PLSQL_WARNINGS = 'ENABLE:ALL'",
]
# Optional trusted local setup, authored by the profile owner and never by the
# agent. Use for session-local initialization that is not an ALTER SESSION.
trusted_session_statements = [
"BEGIN DBMS_OUTPUT.ENABLE(500000); END;",
]
[profiles.oci]
# Optional TCPS/wallet fields. Prefer these named fields over raw
# connect_string query parameters when the value should be validated or redacted.
wallet_location = "/etc/oracle/wallet"
wallet_password_ref = "env:WALLET_PASSWORD"
ssl_server_dn_match = true
ssl_server_cert_dn = "CN=dbhost.example.com"
use_sni = true
# Optional proxy authentication. If enabled, `credential_ref` belongs to
# `proxy_user`; omit top-level `username` or set it to the same value.
# The database needs: ALTER USER <target_schema> GRANT CONNECT THROUGH <proxy_user>
# [profiles.proxy_auth]
# proxy_user = "MCP_PROXY"
# target_schema = "APP_OWNER"
# Optional DRCP server routing. Prefer these named fields over raw
# connect_string query parameters so inheritance, validation, and redaction stay
# predictable. This is separate from [profiles.pool], which controls local
# client-side reuse.
[profiles.drcp]
pooled = true
connection_class = "ORACLE_MCP_AGENTS"
purity = "reuse"
# Optional local client-side pool for stateless metadata/catalog reads where
# pool-backed reads are used.
# User SQL, LOB/sample reads, DBMS_OUTPUT, transactions, and session state stay
# on the pinned main session. Served stateless HTTP uses bounded read-worker
# lanes instead of sharing one pool across lane runtimes.
# [profiles.pool]
# max_size = 4
# min_idle = 1
# acquire_timeout_secs = 5
# statement_cache_size = 50
# Optional driver-level application context, applied during thin logon. Values
# can carry tenant/session identifiers, so list_profiles and diagnostics redact
# them. If inherited, setting entries here replaces the base list; omit to
# inherit or set app_context = [] in the profile table to clear it.
[[profiles.app_context]]
namespace = "ORACLEMCP_CTX"
key = "tenant_id"
value = "tenant-123"
[[profiles.app_context]]
namespace = "ORACLEMCP_CTX"
key = "request_id"
value = "req-456"
[profiles.session_identity]
# Optional: all values are profile-local and are not shown by list_profiles.
# oracle_connection_info reports these only as redacted field names.
# Edition selection is applied during thin authentication before user SQL.
# edition = "ORA$BASE"
program = "oraclemcp"
machine = "local-workstation"
os_user = "local-operator"
terminal = "agent"
driver_name = "oraclemcp"
module = "oraclemcp"
action = "inspect"
client_identifier = "agent"
client_info = "local-workstation"
Keep the signed JSONL and its <audit path>.anchor sidecar together. Run
oraclemcp audit verify /var/lib/oraclemcp/audit/audit.jsonl with the same
secret reference to re-walk the hashes, verify the MAC, and detect a truncated
tail against that anchor. The unsigned refusal trail is deliberately outside
this command and cannot provide those tamper-evidence guarantees; it is the
diagnostic floor only while the signed tier is unavailable.
max_level is the profile ceiling; default_level is the starting session
level and must not exceed that ceiling. call_timeout_seconds defaults to 30
seconds when omitted. It sets the Oracle driver call timeout for the physical
connection and the dispatcher request-budget ceiling for the whole tool call;
tools that expose timeout_seconds can tighten that budget for one call but
cannot loosen the profile ceiling. Set call_timeout_seconds = 0 only as an
explicit opt-out from the driver call timeout; doctor warns on that posture.
login_statements and login_script are for profile-local session policy only
and are restricted to allowlisted ALTER SESSION SET ... parameters.
trusted_session_statements are an explicit profile-owner escape hatch for
local session initialization such as DBMS_APPLICATION_INFO, application
contexts, or DBMS_OUTPUT; they are never accepted from agent tool calls, and
they keep environment-specific conventions in private config rather than in the
open-source core.
The oracle_connection_info tool reports allow-listed connection posture
(backend, connection strategy, server version, role/open mode, read-only
status). Session identity and client topology fields such as os_user,
program, machine, terminal, client_driver, module, action,
client_identifier, and client_info are redacted by default and appear only
as names in redacted_fields when present. The Rust thin backend can still set
the connect-time client identity fields (program, machine, os_user,
terminal, and driver_name) from profile config, and it applies module,
action, client_identifier, and client_info after connect through Oracle
session APIs.
require_signed_tools = true requires HMAC signatures for operator-defined
custom tools on that profile; protected = true implies the same policy. The
resolved audit, OAuth HS256, and custom-tool HMAC keys must each contain at
least 32 bytes of randomly generated key material.
A few further profile keys are optional:
base = "other_profile": inherit another profile's unset fields. A child may override any inherited field, including raisingmax_levelabove the base's value;baseis configuration reuse, not a fleet safety ceiling. To pin a production profile atREAD_ONLY, setprotected = true(which requiresmax_level = "READ_ONLY") on that child; do not rely on aREAD_ONLYbase to constrain it.[profiles.pool]: local client-side connection reuse settings (max_size,min_idle,acquire_timeout_secs,statement_cache_size). This enables the hybrid runtime strategy for stdio/direct dispatch and lane-local metadata reads: catalog and metadata tools such as schema/object/source inspection can use bounded stateless read connections, while agent queries, sampled rows, LOB reads, DDL/write previews, transactions, savepoints, temp tables, package globals, login setup, session identity, andDBMS_OUTPUTstay on the pinned main session. Served stateless HTTP routes generated metadata reads through bounded read-worker lanes instead of sharing one pool across lane runtimes. When the stateless surface is live, expect at least a pinned main Oracle session plus stateless pool session(s);oracle_connection_inforeportsconnection_strategy = "pinned_plus_stateless"and the stateless pool details separately.max_sizeis the knob that caps those additional stateless connections.statement_cache_sizeis passed to the thin driver's bounded per-connection statement cache where pool-backed reads are used; omit it to keep the driver default. This is separate from DRCP server routing.[profiles.oci]: OCI-specific connection settings for the underlying driver. For TCPS/wallet connections, named fields are available forwallet_location,wallet_password_ref,ssl_server_dn_match,ssl_server_cert_dn, anduse_sni. Use the named fields for values that should inherit t
No comments yet
Be the first to share your take.