Skip to content

docs: add Oracle to README and docs - #434

Merged
tianzhou merged 1 commit into
mainfrom
claude/bold-hawking-2n28vd
Sep 19, 2026
Merged

tianzhou merged 1 commit into
mainfrom
claude/bold-hawking-2n28vd

Conversation

@tianzhou

@tianzhou tianzhou commented Sep 19, 2026

Copy link
Copy Markdown
Member

Follow-up to #433, which added the Oracle connector but left the user-facing docs behind.

Changes

  • ASCII architecture charts in README.md and docs/index.mdx list Oracle after SQL Server. Both charts keep their original height, so the MCP client column is untouched; MariaDB moves into the row that was blank.
  • Supported-database lists: README, docs index, the mermaid overview diagram, and the quickstart card.
  • Installation: oracledb added to the driver list, with a note that Thin mode needs no Oracle Instant Client.
  • Command-line page: an Oracle DSN tab (service name, ?sid=, TCPS), the sid query parameter, an Oracle row in the SSL matrix, verify-full wording (PostgreSQL and Oracle; sslrootcert stays PostgreSQL-only), DB_TYPE values, and the default port 1521.
  • TOML page: an individual-parameter Oracle example, connection_timeout / query_timeout / sslmode support lists, and the :1 placeholder row.
  • Tool pages: explain_sql dialect note (EXPLAIN PLAN + DBMS_XPLAN), health_check listed as unsupported on Oracle, COMMENT ON row in the comments table, and an Oracle tab in custom tools.
  • Metadata: package.json and server.json descriptions, plus the MCP Registry DB_TYPE enum. The manifest consistency test passes.

Not changed

  • Blog posts (historical).
  • The health_check overview line, which correctly lists only engines that implement it.
  • The GitHub repository description is a repo setting, not a file, and still omits Oracle.

🤖 Generated with Claude Code

https://claude.ai/code/session_0189BHv585xi8iqEp9JvmgKY

- ASCII architecture charts (README, docs/index) list Oracle after
  SQL Server; both stay 15 rows so the MCP client column is unchanged
- Supported-database lists, mermaid overview, driver list (oracledb,
  Thin mode), quickstart card
- Command-line: Oracle DSN tab (service name, ?sid=, TCPS), `sid`
  query parameter, SSL matrix row, verify-full wording, DB_TYPE and
  default port
- TOML: individual-parameter example, connection/query timeout and
  sslmode support lists, `:1` placeholder row
- Tools: explain_sql dialect note, health_check unsupported note,
  comments table row, custom-tools Oracle tab
- package.json / server.json descriptions and the registry DB_TYPE
  enum include Oracle

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0189BHv585xi8iqEp9JvmgKY
Copilot AI lite review requested due to automatic review settings September 19, 2026 16:20

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟢 Approval recommended

The documentation and metadata updates consistently match the implemented Oracle connector.

Review effort: Lite
Findings: None

What changed in this PR

Adds Oracle to user-facing documentation and package/MCP metadata, aligning docs with the implemented connector.

Changes:

  • Updated architecture diagrams and supported-database lists.
  • Documented Oracle installation, DSNs, SSL modes, TOML configuration, custom tools, and dialect behavior.
  • Updated package and MCP Registry descriptions to include Oracle.
File Description
server.json Adds Oracle to metadata descriptions.
package.json Updates the package description.
README.md Updates architecture and supported-database documentation.
docs/​index.mdx Updates overview diagrams and database lists.
docs/​installation.mdx Documents the Oracle driver.
docs/​quickstart.mdx Adds Oracle to DSN guidance.
docs/​config/​command-line.mdx Documents Oracle DSNs, SSL, SID, and environment settings.
docs/​config/​toml.mdx Adds Oracle TOML examples and supported options.
docs/​tools/​search-objects.mdx Documents Oracle comments syntax.
docs/​tools/​health-check.mdx Documents Oracle’s unsupported status.
docs/​tools/​explain-sql.mdx Documents Oracle explain-plan behavior.
docs/​tools/​custom-tools.mdx Adds an Oracle custom-tool example.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@tianzhou
tianzhou merged commit a3aabe6 into main Sep 19, 2026
4 checks passed
@tianzhou tianzhou changed the title docs: add Oracle to README and docs feat: Oracle health_check, plus README and docs follow-up Sep 19, 2026
@tianzhou tianzhou changed the title feat: Oracle health_check, plus README and docs follow-up docs: add Oracle to README and docs Sep 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants