### Example Verification of MCP Server Package Installation

Source: https://github.com/oracle/mcp/blob/main/README.md

An example command to verify the installation of the 'oracle.oci-api-mcp-server' package from the test PyPI registry.

```bash
uv run --index=https://test.pypi.org/simple oracle.oci-api-mcp-server
```

--------------------------------

### Install dependencies with uv

Source: https://github.com/oracle/mcp/blob/main/src/oci-pricing-mcp-server/README.md

Recommended installation method using uv for reproducible environments. Ensure uv is installed first.

```bash
# Install uv once (e.g., via Homebrew or the official installer)
uv sync --frozen     # uses pyproject.toml / uv.lock
```

--------------------------------

### Install and Run with uv

Source: https://github.com/oracle/mcp/blob/main/src/oci-full-stack-disaster-recovery-mcp-server/README.md

Development installation and running command using uv.

```bash
cd oci-fsdr-mcp
uv sync
uv run oracle.oci-fsdr-mcp-server
```

--------------------------------

### Install with pip (legacy)

Source: https://github.com/oracle/mcp/blob/main/src/oci-full-stack-disaster-recovery-mcp-server/README.md

Legacy installation command using pip.

```bash
pip install -e .
oracle.oci-fsdr-mcp-server
```

--------------------------------

### Set Up Python Virtual Environment and Install Dev Requirements

Source: https://github.com/oracle/mcp/blob/main/README.md

Installs development dependencies using `uv` and activates the virtual environment. Ensure you have Python 3.13 installed.

```sh
uv venv --python 3.13 --seed
source .venv/bin/activate        # On Windows: .venv\Scripts\activate
uv pip install -r requirements-dev.txt
```

--------------------------------

### Build and Install Servers Locally

Source: https://github.com/oracle/mcp/blob/main/README.md

Builds and installs the project's servers within the activated virtual environment using `make` commands.

```sh
make build
make install
```

--------------------------------

### Install with uvx

Source: https://github.com/oracle/mcp/blob/main/src/oci-full-stack-disaster-recovery-mcp-server/README.md

Recommended installation command using uvx to install the OCI FSDR MCP Server.

```bash
uvx --from /path/to/oci-fsdr-mcp oracle.oci-fsdr-mcp-server
```

--------------------------------

### Install fastmcp and httpx with pip

Source: https://github.com/oracle/mcp/blob/main/src/oci-pricing-mcp-server/README.md

Use this command to install the necessary Python packages if you are not using uv.

```bash
pip install fastmcp httpx
```

--------------------------------

### Install MCP Server Dependencies

Source: https://github.com/oracle/mcp/blob/main/src/oracle-db-doc-mcp-server/README.md

Clone the repository, set up a virtual environment, and install dependencies using pip.

```console
git clone https://github.com/oracle/mcp.git

cd mcp/src/oracle-db-doc-mcp-server

python3 -m venv .venv

source .venv/bin/activate

python3 -m pip install -r requirements.txt
```

--------------------------------

### Start MySQL MCP Server

Source: https://github.com/oracle/mcp/blob/main/src/mysql-mcp-server/README.md

This command starts the MySQL MCP server using `uvicorn` for stdio transport. Ensure the `oracle.mysql_mcp_server` module is correctly installed and accessible.

```bash
uv run oracle.mysql_mcp_server
```

--------------------------------

### Enable Authentication with OAuth2

Source: https://github.com/oracle/mcp/blob/main/src/oracle-db-mcp-java-toolkit/README.md

Start the MCP server with authentication enabled using OAuth2. This example configures a local KeyCloak server and restricts access to a specific host.

```bash
java \
    -Ddb.url=jdbc:oracle:thin:@host:1521/service \
    -Dtransport=http \
    -Dhttps.port=45450 \
    -DcertificatePath=/path/to/your-certificate.p12 \
    -DcertificatePassword=yourPassword \
    -DenableAuthentication=true \
    -DauthServer=http://localhost:8080/realms/mcp \
    -DintrospectionEndpoint=http://localhost:8080/realms/mcp/protocol/openid-connect/token/introspect \
    -DclientId=oracle-db-toolkit \
    -DclientSecret=Xj9mPqR2vL5kN8tY3hB7wF4uD6cA1eZ0 \
    -DallowedHosts=http://localhost:6274 \
    -jar <path-to-jar>/oracle-db-mcp-toolkit-1.0.0.jar
```

--------------------------------

### Install Test Dependencies

Source: https://github.com/oracle/mcp/blob/main/tests/README.md

Installs the necessary test dependencies for the project. Ensure your virtual environment is activated before running.

```bash
uv pip install .
```

--------------------------------

### Install Python Prerequisites with uv (Linux/macOS)

Source: https://github.com/oracle/mcp/blob/main/src/oracle-goldengate-mcp-server/README.md

Install Python and set up a virtual environment using uv for the Oracle GoldenGate MCP Server. This ensures reproducible dependency management.

```sh
# Install a supported Python version (project requires >=3.10)
uv python install 3.12

# From the oracle-goldengate-mcp-server directory
uv venv --python 3.12
source .venv/bin/activate

# Install the package and dependencies
uv pip install -e .

# (Optional, recommended) Sync exactly to lockfile versions
uv sync --frozen
```

--------------------------------

### Install Python Prerequisites with uv (Windows PowerShell)

Source: https://github.com/oracle/mcp/blob/main/src/oracle-goldengate-mcp-server/README.md

Install Python and set up a virtual environment using uv for the Oracle GoldenGate MCP Server on Windows. This ensures reproducible dependency management.

```powershell
# Install a supported Python version (project requires >=3.10)
uv python install 3.12

# From the oracle-goldengate-mcp-server directory
uv venv --python 3.12
.
.venv\Scripts\Activate.ps1

# Install the package and dependencies
uv pip install -e .

# (Optional, recommended) Sync exactly to lockfile versions
uv sync --frozen
```

--------------------------------

### MCP Client Configuration for Local Python Server

Source: https://github.com/oracle/mcp/blob/main/README.md

Example MCP client configuration to use a locally installed Python server package. Replace `<path to your cloned repo>` with the actual path to your cloned repository.

```json
{
  "mcpServers": {
    "oracle-oci-api-mcp-server": {
      "command": "uv",
      "args": [
        "run",
        "oracle.oci-api-mcp-server"
      ],
      "env": {
        "VIRTUAL_ENV": "<path to your cloned repo>/mcp/.venv",
        "FASTMCP_LOG_LEVEL": "ERROR"
      }
    }
  }
}
```

--------------------------------

### OCI Config Example

Source: https://github.com/oracle/mcp/blob/main/src/oci-full-stack-disaster-recovery-mcp-server/README.md

Example of OCI configuration file structure with primary and standby region profiles.

```ini
[FSDR_REGION1]
user=ocid1.user.oc1..xxxxxx
fingerprint=xx:xx:xx:...
tenancy=ocid1.tenancy.oc1..xxxxxx
region=us-ashburn-1
key_file=~/.oci/oci_api_key.pem

[FSDR_REGION2]
user=ocid1.user.oc1..xxxxxx
fingerprint=xx:xx:xx:...
tenancy=ocid1.tenancy.oc1..xxxxxx
region=us-phoenix-1
key_file=~/.oci/oci_api_key.pem
```

--------------------------------

### Run OCI Database MCP Server

Source: https://github.com/oracle/mcp/blob/main/src/oci-database-mcp-server/README.md

Use this command to start the OCI Database MCP Server. Ensure the necessary dependencies are installed.

```sh
uv run oracle.oci-database-mcp-server
```

--------------------------------

### Example MQL Query

Source: https://github.com/oracle/mcp/blob/main/src/oci-monitoring-mcp-server/oracle/oci_monitoring_mcp_server/scripts/MQL_QUERY.md

An example demonstrating a complete MQL query with specific metric, interval, dimension filter, grouping, statistic, and predicate.

```text
CpuUtilization[1m]{availabilityDomain = "VeBZ:PHX-AD-1"}.groupBy(poolId).percentile(0.9) > 85
```

--------------------------------

### MQL Arithmetic Examples

Source: https://github.com/oracle/mcp/blob/main/src/oci-monitoring-mcp-server/oracle/oci_monitoring_mcp_server/scripts/MQL_QUERY.md

Provides examples of performing arithmetic operations on metric data, such as calculating available CPU percentage or converting units.

```text
100 - CpuUtilization[1m].mean()                  # available CPU %
```

```text
TotalRequestLatency[1m].mean() / 1000            # ms → seconds
```

--------------------------------

### Example Prompts for Database Administration

Source: https://github.com/oracle/mcp/blob/main/src/dbtools-mcp-server/README.md

Use these prompts to manage databases and connections across your tenancy.

```text
"List all databases in my tenancy"
"Show me the databases in the production compartment"
"Get all database connections"
"What tables exist in the marketing database?"
```

--------------------------------

### Custom Profile Names Example

Source: https://github.com/oracle/mcp/blob/main/src/oci-full-stack-disaster-recovery-mcp-server/README.md

Example of setting custom OCI profile names for primary and standby regions using environment variables.

```bash
FSDR_PROFILE_1=MY_PRIMARY FSDR_PROFILE_2=MY_STANDBY uvx --from . oracle.oci-fsdr-mcp-server
```

--------------------------------

### Install Dependencies

Source: https://github.com/oracle/mcp/blob/main/src/dbtools-mcp-server/README.md

Installs all required Python packages for the DBTools MCP Server.

```bash
pip install -r requirements.txt
```

--------------------------------

### List OCI Clients Tool Example

Source: https://github.com/oracle/mcp/blob/main/src/oci-cloud-mcp-server/README.md

Example JSON payload for the `list_oci_clients` tool. This tool lists discoverable OCI SDK clients for capability discovery and debugging.

```json
{}
```

--------------------------------

### Log Stream Examples

Source: https://github.com/oracle/mcp/blob/main/src/oci-logging-mcp-server/oracle/oci_logging_mcp_server/scripts/SEARCH_LOG.md

Provides concrete examples of how to specify log streams for searches, ranging from specific log objects to entire compartments.

```Logging Query Language
search "compartmentOcid/logGroupNameOrOcid/logNameOrOcid"
```

```Logging Query Language
search "compartmentOcid/logGroupNameOrOcid"
```

```Logging Query Language
search "compartmentOcid"
```

```Logging Query Language
search "compartmentOcid/logGroupNameOrOcid/logNameOrOcid", "compartmentOcid_2/logGroupNameOrOcid_2", "compartmentOcid_3"
```

--------------------------------

### Example Prompts for OCI Object Store Tools

Source: https://github.com/oracle/mcp/blob/main/src/dbtools-mcp-server/README.md

Use these prompts to list buckets and objects within your OCI Object Storage.

```text
"What buckets do I have?"
"List objects in my bucket"
```

--------------------------------

### Enable Authentication via Command Line

Source: https://github.com/oracle/mcp/blob/main/src/oracle-db-mcp-java-toolkit/README.md

Use this command to start the toolkit with authentication enabled for development and testing. Ensure the JAR path and certificate details are correct.

```bash
java \
    -Ddb.url=jdbc:oracle:thin:@host:1521/service \
    -Dtransport=http \
    -Dhttps.port=45450 \
    -DcertificatePath=/path/to/your-certificate.p12 \
    -DcertificatePassword=yourPassword \
    -DenableAuthentication=true \
    -jar <path-to-jar>/oracle-db-mcp-toolkit-1.0.0.jar
```

--------------------------------

### Example .env Configuration

Source: https://github.com/oracle/mcp/blob/main/tests/README.md

A template for the .env file used to configure environment variables for the tests. Fill in the required values.

```bash
MCP_HOST_FILE=
URL=
MODEL=
```

--------------------------------

### MCP Client Configuration

Source: https://github.com/oracle/mcp/blob/main/src/oci-full-stack-disaster-recovery-mcp-server/README.md

Example server configuration for an MCP-aware client using stdio servers.

```json
{
  "mcpServers": {
    "oci-fsdr": {
      "command": "uvx",
      "args": ["--from", "/path/to/oci-fsdr-mcp", "oracle.oci-fsdr-mcp-server"],
      "env": {
        "FSDR_PROFILE_1": "FSDR_REGION1",
        "FSDR_PROFILE_2": "FSDR_REGION2"
      }
    }
  }
}
```

--------------------------------

### Example Prompts for Table Management

Source: https://github.com/oracle/mcp/blob/main/src/dbtools-mcp-server/README.md

Use these prompts to create, view, modify, or delete tables in your database.

```text
"Create an employee table in the HR database with columns for ID, name, email, and salary"
"Show me all tables in the finance database"
"Add a department column to the employee table"
"Delete the test_table from my database"
```

--------------------------------

### MCP Server Configuration Example

Source: https://github.com/oracle/mcp/blob/main/src/dbtools-mcp-server/README.md

Example JSON configuration for integrating the DBTools MCP Server with a client like Claude UI on Windows. Specifies the command to run the Python script and its arguments.

```json
{
  "mcpServers": {
    "dbtools": {
      "command": "C:\\Python\\python.exe",
      "args": [
        "C:\\Users\\user1\\mcp\\src\\dbtools-mcp-server\\dbtools-mcp-server.py"
      ]
    }
  }
}
```

--------------------------------

### Verify Installation from PyPI Test Registry

Source: https://github.com/oracle/mcp/blob/main/README.md

Verify that packages published to the test registry can be installed. Replace <mcp server package> with the actual package name.

```bash
uv run --index=https://test.pypi.org/simple <mcp server package>
```

--------------------------------

### Start DBTools MCP Server

Source: https://github.com/oracle/mcp/blob/main/src/dbtools-mcp-server/README.md

Command to start the DBTools MCP Server using Python. The server runs using stdio transport.

```bash
python dbtools-mcp-server.py
```

--------------------------------

### Start MCP Server with HTTPS Enabled

Source: https://github.com/oracle/mcp/blob/main/src/oracle-db-mcp-java-toolkit/README.md

Use this command to start the MCP server with HTTPS enabled. Specify your certificate keystore path, password, and the desired HTTPS port. Only PKCS12 keystore files are supported.

```shell
java \
  -Dtransport=http \
  -Dhttps.port=45450 \
  -DcertificatePath=/path/to/your-certificate.p12 \
  -DcertificatePassword=yourPassword \
  -Ddb.url=jdbc:oracle:thin:@your-host:1521/your-service \
  -Ddb.user=your_user \
  -Ddb.password=your_password \
  -Dtools=jdbc-analyzer \
  -jar <path-to-jar>/oracle-db-mcp-toolkit-1.0.0.jar
```

--------------------------------

### Create Pluggable Database

Source: https://github.com/oracle/mcp/blob/main/src/oci-database-mcp-server/README.md

Creates and starts a pluggable database.

```APIDOC
## create_pluggable_database

### Description
Create and start a pluggable database.

### Method
POST

### Endpoint
/pluggableDatabases
```

--------------------------------

### Example Prompts for Data Querying

Source: https://github.com/oracle/mcp/blob/main/src/dbtools-mcp-server/README.md

Use these prompts to query data, retrieve specific information, and analyze database contents.

```text
"What's the average salary of employees by department?"
"Show me all employees hired in the last 6 months"
"List the top 5 departments by headcount"
"Get all projects with status 'In Progress'"
```

--------------------------------

### Start OCI Support MCP Server (HTTP)

Source: https://github.com/oracle/mcp/blob/main/src/oci-support-mcp-server/README.md

Start the OCI Support MCP server for HTTP transport. Ensure all required environment variables are set, including OCI region, IDCS details, and host/port information.

```sh
ORACLE_MCP_HOST=<bind_host> \
ORACLE_MCP_PORT=<port> \
ORACLE_MCP_BASE_URL=<public_base_url> \
OCI_REGION=<region> \
IDCS_DOMAIN=<idcs_domain> \
IDCS_CLIENT_ID=<client_id> \
IDCS_CLIENT_SECRET=<client_secret> \
IDCS_AUDIENCE=<audience> \
uvx oracle.oci-support-mcp-server
```

--------------------------------

### Run Server from Source (uv run)

Source: https://github.com/oracle/mcp/blob/main/src/oci-opensearch-mcp-server/README.md

Start the OCI OpenSearch MCP Server from local source code using the 'uv run' command.

```sh
uv run oracle.oci-opensearch-mcp-server
```

--------------------------------

### Run OCI IoT MCP Server

Source: https://github.com/oracle/mcp/blob/main/src/oci-iot-mcp-server/README.md

Use this command to start the OCI IoT MCP Server. Ensure the environment is set up correctly.

```sh
uv run oracle.oci-iot-mcp-server
```

--------------------------------

### Constructing a Search URL

Source: https://github.com/oracle/mcp/blob/main/src/oci-logging-mcp-server/oracle/oci_logging_mcp_server/scripts/SEARCH_LOG.md

This is an example of how to construct a URL for the logging plugin with search parameters. Ensure all parameters are URL encoded.

```URL
https://cloud.oracle.com/logging/search?searchQuery=<search_query>&start=<time_start>&end=<time_end>&timeOption=custom
```

--------------------------------

### Basic MCP Server Configuration for OCI Pricing

Source: https://github.com/oracle/mcp/blob/main/src/oci-pricing-mcp-server/README.md

Example JSON configuration for setting up the OCI Pricing MCP server, specifying the command and arguments. This is typical for stdio transport.

```json
{
  "mcpServers": {
    "oci-pricing": {
      "command": "C:\\Python\\python.exe",
      "args": [
        "C:\\Users\\user1\\oci-pricing-mcp-server\\oci-pricing-mcp-server.py"
      ]
    }
  }
}
```

--------------------------------

### Configure MCP Server

Source: https://github.com/oracle/mcp/blob/main/src/oracle-db-doc-mcp-server/README.md

Configure the MCP server by adding this JSON content to your `.vscode/mcp.json` file. Replace placeholders with your installation paths.

```json
{
  "servers": {
    "oracle-db-doc": {
      "type": "stdio",
      "command": "<installation>/.venv/bin/python3",
      "args": [ "oracle-db-doc-mcp-server.py", "mcp" ]
    }
  }
}
```

--------------------------------

### Example Prompts for Compartment Management

Source: https://github.com/oracle/mcp/blob/main/src/dbtools-mcp-server/README.md

Use these prompts to list and retrieve details about compartments within your OCI tenancy.

```text
"Show me all compartments"
"List databases in the development compartment"
"Get details of the production compartment"
```

--------------------------------

### Example Prompts for HeatWave Tools

Source: https://github.com/oracle/mcp/blob/main/src/dbtools-mcp-server/README.md

Use these prompts to interact with HeatWave ML features for natural language querying and model training.

```text
"Ask ml_rag: What is the most prestigious Grand Prix?"
"How can I train a model to predict food delivery times?"
"Create a vector store from files in my bucket"
```

--------------------------------

### Build and Test Tasks

Source: https://github.com/oracle/mcp/blob/main/src/oci-recovery-mcp-server/README.md

Manage development tasks such as building, installing, testing, linting, and formatting the code using the provided Makefile.

```sh
make build
```

```sh
make install
```

```sh
make test
```

```sh
make lint
```

```sh
make format
```

--------------------------------

### Search for Launch Instance Begin Event

Source: https://github.com/oracle/mcp/blob/main/src/oci-logging-mcp-server/oracle/oci_logging_mcp_server/scripts/SEARCH_LOG_EVENT_TYPES.md

Use this query to find log entries related to the start of a compute instance launch. Ensure you are using the exact event type string.

```logql
| where type = 'com.oraclecloud.computeapi.launchinstance.begin'
```

--------------------------------

### Create Replicat with OBEY File and Additional Parameters

Source: https://github.com/oracle/mcp/blob/main/src/oracle-goldengate-mcp-server/docs/createReplicat.md

This example shows how to use an OBEY file for Replicat configuration and include additional parameters. The `mapStatement` is provided as a raw string.

```json
{
  "replicatName": "REP_MOD",
  "trailName": "MD",
  "domainName": "OracleGoldenGate",
  "connectionName": "ggadmin",
  "mapStatement": "MAP hr.?TAB, TARGET hr.?TAB;",
  "advanced": {
    "obey": "common_settings.prm"
  }
}
```

--------------------------------

### MCP Client Configuration for Python Server

Source: https://github.com/oracle/mcp/blob/main/README.md

Example MCP client configuration for a typical Python server. This JSON defines how to connect to and run an MCP server using `uvx`.

```json
{
  "mcpServers": {
    "oracle-oci-api-mcp-server": {
      "command": "uvx",
      "args": [
        "oracle.oci-api-mcp-server@latest"
      ],
      "env": {
        "FASTMCP_LOG_LEVEL": "ERROR"
      }
    }
  }
}
```

--------------------------------

### MCP Server Configuration with Environment Variable

Source: https://github.com/oracle/mcp/blob/main/src/oci-pricing-mcp-server/README.md

Example JSON configuration to set the default currency to JPY for the OCI Pricing MCP server using the 'env' field.

```json
{
  "mcpServers": {
    "oci-pricing": {
      "command": "C:\\Python\\python.exe",
      "args": [
        "C:\\Users\\user1\\oci-pricing-mcp-server\\oci-pricing-mcp-server.py"
      ],
      "env": {
        "OCI_PRICING_DEFAULT_CCY": "JPY"
      }
    }
  }
}
```

--------------------------------

### Create Replicat with Structured MAP and Advanced Options

Source: https://github.com/oracle/mcp/blob/main/src/oracle-goldengate-mcp-server/docs/createReplicat.md

This example demonstrates creating a Replicat using structured source and options, including advanced DBOPTIONS and BATCHSQL parameters. The `extTrail` parameter overrides the default EXTTRAIL path.

```json
{
  "replicatName": "MYREP",
  "trailName": "LT",
  "domainName": "OracleGoldenGate",
  "connectionName": "TARGET_CONN",
  "source": {
    "schema": "SCHEMA",
    "table": "*",
    "targetTable": "SCHEMA.*"
  },
  "advanced": {
    "dbOptions": [
      "FETCHBATCHSIZE 5000",
      "EMPTYLOBSTRING 'N/A'"
    ],
    "batchSql": [
      "BATCHERRORMODE",
      "BATCHESPERQUEUE 100",
      "OPSPERBATCH 2000"
    ],
    "extTrail": "./dirdat/lt"
  }
}
```

--------------------------------

### Run Server from Source (uvx --from .)

Source: https://github.com/oracle/mcp/blob/main/src/oci-opensearch-mcp-server/README.md

Execute the OCI OpenSearch MCP Server from local source code using the 'uvx --from .' command.

```sh
uvx --from . oracle.oci-opensearch-mcp-server
```

--------------------------------

### Get Historized Data

Source: https://github.com/oracle/mcp/blob/main/src/oci-iot-mcp-server/README.md

Gets a historized data record by identifier from the Oracle IoT Data API for a specific IoT domain.

```APIDOC
## get_historized_data

### Description
Gets a historized data record by identifier from the Oracle IoT Data API for a specific IoT domain.

### Method
GET

### Endpoint
/iot/data/historized/{recordId}

### Parameters
#### Path Parameters
- **recordId** (string) - Required - The unique identifier of the historized data record.
#### Query Parameters
- **iotDomainId** (string) - Required - The identifier of the IoT domain.
```

--------------------------------

### Start Local MCP Server (HTTP Transport)

Source: https://github.com/oracle/mcp/blob/main/README.md

Launch your local MCP server using uv, specifying host and port. Environment variables like VIRTUAL_ENV and ORACLE_MCP_HOST/PORT are important for correct operation.

```bash
VIRTUAL_ENV=$(pwd)/.venv ORACLE_MCP_HOST=127.0.0.1 ORACLE_MCP_PORT=8888 uv run oracle.oci-api-mcp-server
```

--------------------------------

### Get Raw Command Data

Source: https://github.com/oracle/mcp/blob/main/src/oci-iot-mcp-server/README.md

Gets a raw command data record by identifier from the Oracle IoT Data API for a specific IoT domain.

```APIDOC
## get_raw_command_data

### Description
Gets a raw command data record by identifier from the Oracle IoT Data API for a specific IoT domain.

### Method
GET

### Endpoint
/iot/data/raw/commands/{commandId}

### Parameters
#### Path Parameters
- **commandId** (string) - Required - The unique identifier of the raw command data record.
#### Query Parameters
- **iotDomainId** (string) - Required - The identifier of the IoT domain.
```

--------------------------------

### Create Oracle Database Documentation Index

Source: https://github.com/oracle/mcp/blob/main/src/oracle-db-doc-mcp-server/README.md

Use the 'idx' subcommand to create or maintain the documentation index. Point to the zip file or an extracted directory using the -path argument. Preprocessing levels can be adjusted.

```console
usage: oracle-db-doc-mcp-server.py idx [-h] -path PATH [-preprocess PREPROCESS]

options:
  -h, --help            show this help message and exit
  -path PATH            path to the documentation input zip file or extracted directory
  -preprocess PREPROCESS
                        preprocessing level of documentation (NONE, BASIC (default), ADVANCED)
```

```console
python3 oracle-db-doc-mcp-server.py idx -path ~/Downloads/oracle-database_26.zip
```

--------------------------------

### Invoke OCI API Tool Example

Source: https://github.com/oracle/mcp/blob/main/src/oci-cloud-mcp-server/README.md

Example of invoking an OCI Python SDK client method using `invoke_oci_api`. Specify `client_fqn`, `operation`, and `params`.

```json
{"client_fqn": "oci.core.ComputeClient", "operation": "list_instances", "params": {"compartment_id": "ocid1.compartment.oc1..."}}
```

--------------------------------

### Start MCP Toolkit Server (HTTP)

Source: https://github.com/oracle/mcp/blob/main/src/oracle-db-mcp-java-toolkit/DEMO.md

Launches the MCP Toolkit server with HTTP transport, specifying HTTPS port, certificate details, authentication, and enabled tools. The JAR path needs to be adjusted.

```bash
java \
  -Dtransport=http \
  -Dhttps.port=45450 \
  -DcertificatePath=/path/to/your-certificate.p12 \
  -DcertificatePassword=yourPassword \
  -DenableAuthentication=true \
  -Dtools=get-jdbc-stats,get-jdbc-queries,get-jdbc-errors,jdbc-log-comparison,get-rdbms-errors,get-rdbms-packet-dumps \
  -jar <path-to-jar>/oracle-db-mcp-toolkit-1.0.0.jar
```

--------------------------------

### Install OCI Recovery MCP Server

Source: https://github.com/oracle/mcp/blob/main/src/oci-recovery-mcp-server/README.md

Install the OCI Recovery Service MCP Server package. This can be done from the repository root or directly within the package directory.

```sh
make build
uv pip install ./src/oci-recovery-mcp-server
```

```sh
cd src/oci-recovery-mcp-server
uv build
uv pip install .
```

--------------------------------

### MCP Server Main Entry Point

Source: https://github.com/oracle/mcp/blob/main/BEST_PRACTICES.md

Implement a main function in server.py to handle command-line arguments, environment setup, and server initialization. This serves as the single entry point for the application.

```python
def main():
    """Run the MCP server with CLI argument support."""
    mcp.run()


if __name__ == '__main__':
    main()
```

--------------------------------

### Find OCI API Tool Example Usage

Source: https://github.com/oracle/mcp/blob/main/src/oci-cloud-mcp-server/README.md

Example JSON payload for the `find_oci_api` tool, used for keyword search across OCI SDK client methods.

```json
{
  "query": "list instances",
  "limit": 5
}
```

--------------------------------

### Key - Create Begin

Source: https://github.com/oracle/mcp/blob/main/src/oci-logging-mcp-server/oracle/oci_logging_mcp_server/scripts/SEARCH_LOG_EVENT_TYPES.md

Represents the event for the initiation of creating a Key.

```APIDOC
## Key - Create Begin

### Description
Logs the start of the process to create a Key.

### Method
Not specified (Implied API call)

### Endpoint
Not specified

### Parameters
None specified

### Request Example
None specified

### Response
None specified
```

--------------------------------

### Bastion - Create Session Begin

Source: https://github.com/oracle/mcp/blob/main/src/oci-logging-mcp-server/oracle/oci_logging_mcp_server/scripts/SEARCH_LOG_EVENT_TYPES.md

Represents the event for the initiation of creating a Bastion session.

```APIDOC
## Bastion - Create Session Begin

### Description
Logs the start of the process to create a Bastion session.

### Method
Not specified (Implied API call)

### Endpoint
Not specified

### Parameters
None specified

### Request Example
None specified

### Response
None specified
```

--------------------------------

### Start OCI Load Balancer MCP Server (HTTP Transport)

Source: https://github.com/oracle/mcp/blob/main/src/oci-load-balancer-mcp-server/README.md

Start the OCI Load Balancer MCP server using HTTP transport. Ensure all required environment variables are set, including OCI and IDCS configurations.

```sh
ORACLE_MCP_HOST=<bind_host> \
ORACLE_MCP_PORT=<port> \
ORACLE_MCP_BASE_URL=<public_base_url> \
OCI_REGION=<region> \
IDCS_DOMAIN=<idcs_domain> \
IDCS_CLIENT_ID=<client_id> \
IDCS_CLIENT_SECRET=<client_secret> \
IDCS_AUDIENCE=<audience> \
uvx oracle.oci-load-balancer-mcp-server
```

--------------------------------

### Costs by Clin - Get

Source: https://github.com/oracle/mcp/blob/main/src/oci-logging-mcp-server/oracle/oci_logging_mcp_server/scripts/SEARCH_LOG_EVENT_TYPES.md

Represents the event for retrieving costs by CLIN.

```APIDOC
## Costs by Clin - Get

### Description
Logs an operation to retrieve cost information categorized by CLIN (Customer Line Item Number).

### Method
Not specified (Implied API call)

### Endpoint
Not specified

### Parameters
None specified

### Request Example
None specified

### Response
None specified
```

--------------------------------

### Get Autonomous Database

Source: https://github.com/oracle/mcp/blob/main/src/oci-database-mcp-server/README.md

Retrieves the details of the specified Autonomous Database.

```APIDOC
## get_autonomous_database

### Description
Gets the details of the specified Autonomous Database.

### Method
GET

### Endpoint
/autonomousDatabases/{autonomousDatabaseId}
```

--------------------------------

### Create Replicat with DDL Handling and Source Catalog

Source: https://github.com/oracle/mcp/blob/main/src/oracle-goldengate-mcp-server/docs/createReplicat.md

Configure Replicat for DDL handling and specify source catalog information. This example includes settings for DDL errors, replication errors, and assumes target definitions.

```json
{
  "replicatName": "REP_DDL",
  "trailName": "DD",
  "domainName": "OracleGoldenGate",
  "connectionName": "ggadmin",
  "source": {
    "schema": "APP",
    "table": "SCHEMAA.*",
    "targetTable": "APP.SCHEMAA.*"
  },
  "advanced": {
    "ddlError": "default discard",
    "repError": "(default, discard)",
    "ddlOptions": "REPORT",
    "sourceCatalog": "PDB1",
    "assumeTargetDefs": true
  }
}
```

--------------------------------

### Get Pluggable Database

Source: https://github.com/oracle/mcp/blob/main/src/oci-database-mcp-server/README.md

Retrieves information about a specific pluggable database.

```APIDOC
## get_pluggable_database

### Description
Get information about a specific pluggable database.

### Method
GET

### Endpoint
/pluggableDatabases/{pluggableDatabaseId}
```

--------------------------------

### List All Configured Database Connections

Source: https://github.com/oracle/mcp/blob/main/src/mysql-mcp-server/README.md

Use this prompt to retrieve a list of all database connections that have been configured and loaded by the MySQL MCP server.

```string
"List all configured database connections"
```

--------------------------------

### Get Autonomous Database Wallet

Source: https://github.com/oracle/mcp/blob/main/src/oci-database-mcp-server/README.md

Retrieves the wallet details for the specified Autonomous Database.

```APIDOC
## get_autonomous_database_wallet

### Description
Gets the wallet details for the specified Autonomous Database.

### Method
GET

### Endpoint
/autonomousDatabases/{autonomousDatabaseId}/wallet
```

--------------------------------

### Get Autonomous Database Backup

Source: https://github.com/oracle/mcp/blob/main/src/oci-database-mcp-server/README.md

Retrieves information about the specified Autonomous Database backup.

```APIDOC
## get_autonomous_database_backup

### Description
Gets information about the specified Autonomous Database backup.

### Method
GET

### Endpoint
/autonomousDatabaseBackups/{autonomousDatabaseBackupId}
```

--------------------------------

### Get Autonomous Container Database

Source: https://github.com/oracle/mcp/blob/main/src/oci-database-mcp-server/README.md

Retrieves information about the specified Autonomous Container Database.

```APIDOC
## get_autonomous_container_database

### Description
Gets information about the specified Autonomous Container Database.

### Method
GET

### Endpoint
/autonomousContainerDatabases/{autonomousContainerDatabaseId}
```

--------------------------------

### PDB Conversion History Entry Operations

Source: https://github.com/oracle/mcp/blob/main/src/oci-database-mcp-server/README.md

Get details of operations performed for PDB conversion.

```APIDOC
## get_pdb_conversion_history_entry

### Description
Gets the details of operations performed to convert the specified database from non-container (non-CDB) to pluggable (PDB).

### Method
GET

### Endpoint
/pdbConversionHistoryEntries/{historyEntryId}

### Parameters
#### Path Parameters
- **historyEntryId** (string) - Required - The ID of the PDB conversion history entry.
```

--------------------------------

### Claude Desktop Podman Configuration (stdio)

Source: https://github.com/oracle/mcp/blob/main/src/oracle-db-mcp-java-toolkit/README.md

Configure Claude Desktop to use the MCP server via Podman with stdio transport. This example specifies the command, arguments, volume mounts, environment variables, and image name for the Podman run command.

```json
{
  "mcpServers": {
    "oracle-db-mcp-toolkit": {
      "command": "podman",
      "args": [
        "run",
        "--rm",
        "-i",
        "-v", "/absolute/path/to/ext:/ext:ro",
        "-e",
        "JAVA_TOOL_OPTIONS=-Ddb.url=jdbc:oracle:thin:@your-host:1521/your-service -Ddb.user=your_user -Ddb.password=your_password -Dojdbc.ext.dir=/ext -DconfigFile=/config/config.yaml",
        "oracle-db-mcp-toolkit:1.0.0"
      ]
    }
  }
}
```

--------------------------------

### Infrastructure Target Versions

Source: https://github.com/oracle/mcp/blob/main/src/oci-database-mcp-server/README.md

Get details of Exadata Infrastructure target system software versions.

```APIDOC
## get_infrastructure_target_versions

### Description
Gets details of the Exadata Infrastructure target system software versions that can be applied to the specified infrastructure resource for maintenance updates.

### Method
GET

### Endpoint
/infrastructureTargets/{infrastructureTargetId}/versions

### Parameters
#### Path Parameters
- **infrastructureTargetId** (string) - Required - The ID of the infrastructure resource.
```

--------------------------------

### Get Cloud Exadata Infrastructure (Deprecated)

Source: https://github.com/oracle/mcp/blob/main/src/oci-database-mcp-server/README.md

Deprecated. Use get_cloud_exadata_infrastructure and get_cloud_autonomous_vm_cluster operations instead.

```APIDOC
## get_autonomous_exadata_infrastructure

### Description
**Deprecated.** Use the :func:`get_cloud_exadata_infrastructure` operation to get details of an Exadata Infrastructure resource and the :func:`get_cloud_autonomous_vm_cluster` operation to get details of an Autonomous Exadata VM cluster.

### Method
GET

### Endpoint
/autonomousExadataInfrastructures/{autonomousExadataInfrastructureId}
```

--------------------------------

### Field Examples

Source: https://github.com/oracle/mcp/blob/main/src/oci-logging-mcp-server/oracle/oci_logging_mcp_server/scripts/SEARCH_LOG.md

Illustrates various ways to reference fields, including simple names, nested paths, and handling of special characters and spaces within field names.

```Logging Query Language
type
```

```Logging Query Language
data.message
```

```Logging Query Language
data.request.URL
```

```Logging Query Language
"type"
```

```Logging Query Language
"data"."message"
```

```Logging Query Language
"data.message" (not the same as "data"."message")
```

```Logging Query Language
data."$event"
```

```Logging Query Language
data."first name"
```

```Logging Query Language
data."an example of escaped ("') double quotes"
```

--------------------------------

### Get Autonomous Database Regional Wallet

Source: https://github.com/oracle/mcp/blob/main/src/oci-database-mcp-server/README.md

Retrieves the Autonomous Database regional wallet details.

```APIDOC
## get_autonomous_database_regional_wallet

### Description
Gets the Autonomous Database regional wallet details.

### Method
GET

### Endpoint
/autonomousDatabases/regionalWallet
```

--------------------------------

### Get Application VIP

Source: https://github.com/oracle/mcp/blob/main/src/oci-database-mcp-server/README.md

Retrieves information about a specified application virtual IP (VIP) address.

```APIDOC
## get_application_vip

### Description
Gets information about a specified application virtual IP (VIP) address.

### Method
GET

### Endpoint
/applicationVips/{applicationVipId}
```

--------------------------------

### Execute SQL Script on a Connection

Source: https://github.com/oracle/mcp/blob/main/src/mysql-mcp-server/README.md

This prompt demonstrates how to execute a raw SQL script against a specified database connection. Replace 'my connection' and the SQL query with your specific details.

```string
"Execute 'SELECT * FROM employees' on my connection"
```

--------------------------------

### Build Docker Image

Source: https://github.com/oracle/mcp/blob/main/src/oci-pricing-mcp-server/README.md

Build the Docker image for the OCI Pricing MCP server with the tag 'oci-pricing-mcp:dev'.

```bash
# Build
docker build -t oci-pricing-mcp:dev .
```

--------------------------------

### Get Autonomous Database Software Image

Source: https://github.com/oracle/mcp/blob/main/src/oci-database-mcp-server/README.md

Retrieves information about the specified Autonomous Database Software Image.

```APIDOC
## get_autonomous_database_software_image

### Description
Gets information about the specified Autonomous Database Software Image.

### Method
GET

### Endpoint
/autonomousDatabaseSoftwareImages/{autonomousDatabaseSoftwareImageId}
```

--------------------------------

### Transaction Management

Source: https://github.com/oracle/mcp/blob/main/src/oracle-db-mcp-java-toolkit/README.md

Manage database transactions, including starting, verifying, committing, and rolling back transactions.

```APIDOC
## transaction

### Description
Manages the lifecycle of database transactions.

### Method
Not specified (Tool)

### Endpoint
Not specified (Tool)

### Parameters
#### Query Parameters
- **action** (string, required) - The transaction action: `start`, `resume`, `commit`, `rollback`.
- **txId** (string, required for `resume`, `commit`, `rollback`) - The transaction ID.

### Request Example
```
-Dtools=database-operator -Dtool.transaction.action=start
-Dtools=database-operator -Dtool.transaction.action=resume -Dtool.transaction.txId=abc123xyz
-Dtools=database-operator -Dtool.transaction.action=commit -Dtool.transaction.txId=abc123xyz
-Dtools=database-operator -Dtool.transaction.action=rollback -Dtool.transaction.txId=abc123xyz
```

### Response
#### Success Response (200)
- For `start`: Transaction ID.
- For `resume`: Status indicating if the transaction is active.
- For `commit`, `rollback`: Success message.

#### Response Example
```json
{
  "example": "Transaction ID: abc123xyz"
}
```
```

--------------------------------

### MCP Server Package Entry Point Configuration

Source: https://github.com/oracle/mcp/blob/main/BEST_PRACTICES.md

Configure the package entry point in pyproject.toml to specify the main function that should be executed when the package is run as a script.

```toml
[project.scripts]
"oracle.mcp-server-name" = "oracle.mcp_server_name.server:main"
```

--------------------------------

### Get Latest Twin State

Source: https://github.com/oracle/mcp/blob/main/src/oci-iot-mcp-server/README.md

Returns the latest observed snapshot, historized, raw-command, and rejected-data records for a twin.

```APIDOC
## get_latest_twin_state

### Description
Returns the latest observed snapshot, historized, raw-command, and rejected-data records for a twin.

### Method
GET

### Endpoint
/iot/twins/{twinId}/state/latest
```

--------------------------------

### Get Twin Platform Context

Source: https://github.com/oracle/mcp/blob/main/src/oci-iot-mcp-server/README.md

Returns the control-plane and domain-context resources that explain how a twin is wired into OCI IoT.

```APIDOC
## get_twin_platform_context

### Description
Returns the control-plane and domain-context resources that explain how a twin is wired into OCI IoT.

### Method
GET

### Endpoint
/iot/twins/{twinId}/context
```

--------------------------------

### Development Commands

Source: https://github.com/oracle/mcp/blob/main/src/oci-full-stack-disaster-recovery-mcp-server/README.md

Commands for synchronizing dependencies and running tests during development.

```bash
uv sync --extra dev
uv run pytest

```

--------------------------------

### Search for Launch Instance End Event

Source: https://github.com/oracle/mcp/blob/main/src/oci-logging-mcp-server/oracle/oci_logging_mcp_server/scripts/SEARCH_LOG_EVENT_TYPES.md

Use this query to find log entries related to the completion of a compute instance launch. Exact event type matching is required.

```logql
| where type = 'com.oraclecloud.computeapi.launchinstance.end'
```

--------------------------------

### Data Store - Create Begin

Source: https://github.com/oracle/mcp/blob/main/src/oci-logging-mcp-server/oracle/oci_logging_mcp_server/scripts/SEARCH_LOG_EVENT_TYPES.md

Represents the event for the initiation of creating a Data Store.

```APIDOC
## Data Store - Create Begin

### Description
Logs the start of the process to create a Data Store.

### Method
Not specified (Implied API call)

### Endpoint
Not specified

### Parameters
None specified

### Request Example
None specified

### Response
None specified
```

--------------------------------

### Get Latest Twin State

Source: https://github.com/oracle/mcp/blob/main/src/oci-iot-mcp-server/README.md

Retrieve the latest observed records for a twin. Requires the digital twin instance ID.

```json
{
  "tool": "get_latest_twin_state",
  "arguments": {
    "digital_twin_instance_id": "ocid1.digitaltwininstance.oc1..example"
  }
}
```