Skip to main content

OCI Recovery Service MCP server

Project description

OCI Recovery Service MCP Server

OCI Model Context Protocol (MCP) server exposing Oracle Cloud Recovery Service operations as MCP tools.

Features

  • List Protected Databases with rich filtering (compartment, lifecycle_state, display_name, id, protection_policy_id, recovery_service_subnet_id, limit, page, sort_order, sort_by, opc_request_id, region).
  • Mapping of OCI SDK models to Pydantic for safe, serializable responses.

MCP client configuration (recommended)

Most users should configure their MCP client to launch the server, rather than starting it manually.

Add a stanza like this to your MCP client config (often called mcp.json; example shown is stdio):

{
  "mcpServers": {
    "oci-recovery": {
      "type": "stdio",
      "command": "uvx",
      "args": [
        "oracle.oci-recovery-mcp-server"
      ],
      "env": {
        "OCI_CONFIG_PROFILE": "DEFAULT"
      }
    }
  }
}

For HTTP transport, start the server with:

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-recovery-mcp-server

Register ${ORACLE_MCP_BASE_URL}/auth/callback in the OCI IAM confidential application. If IDCS_REQUIRED_SCOPES is unset, the default is openid profile email oci_mcp.recovery.invoke. stdio uses the configured OCI CLI profile; HTTP uses the authenticated OCI IAM user.

Install

From this repository root:

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

Or directly inside the package directory:

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

Tools

  • get_compartment_by_name_tool(name) -> str
  • list_protected_databases(compartment_id, lifecycle_state=None, display_name=None, id=None, protection_policy_id=None, recovery_service_subnet_id=None, limit=None, page=None, sort_order=None, sort_by=None, opc_request_id=None, region=None) -> list[ProtectedDatabaseSummary]
  • get_protected_database(protected_database_id, opc_request_id=None, region=None) -> ProtectedDatabase
  • summarize_protected_database_health(compartment_id=None, region=None) -> ProtectedDatabaseHealthCounts
  • summarize_protected_database_redo_status(compartment_id=None, region=None) -> ProtectedDatabaseRedoCounts
  • summarize_backup_space_used(compartment_id=None, region=None) -> ProtectedDatabaseBackupSpaceSum
  • list_protection_policies(compartment_id, lifecycle_state=None, display_name=None, id=None, limit=None, page=None, sort_order=None, sort_by=None, opc_request_id=None, region=None) -> list[ProtectionPolicySummary]
  • get_protection_policy(protection_policy_id, opc_request_id=None, region=None) -> ProtectionPolicy
  • list_recovery_service_subnets(compartment_id, lifecycle_state=None, display_name=None, id=None, vcn_id=None, limit=None, page=None, sort_order=None, sort_by=None, opc_request_id=None, region=None) -> list[RecoveryServiceSubnetSummary]
  • get_recovery_service_subnet(recovery_service_subnet_id, opc_request_id=None, region=None) -> RecoveryServiceSubnet
  • get_recovery_service_metrics(compartment_id, start_time, end_time, metricName="SpaceUsedForRecoveryWindow", resolution="1h", aggregation="max", protected_database_id=None) -> list[dict]
  • list_databases(compartment_id=None, db_home_id=None, system_id=None, limit=None, page=None, sort_by=None, sort_order=None, lifecycle_state=None, db_name=None, region=None) -> list[DatabaseSummary]
  • get_database(database_id, region=None) -> Database
  • list_backups(compartment_id=None, database_id=None, lifecycle_state=None, type=None, limit=None, page=None, region=None) -> list[BackupSummary]
  • get_backup(backup_id, region=None) -> Backup
  • summarize_protected_database_backup_destination(compartment_id=None, region=None, db_home_id=None, include_last_backup_time=False) -> ProtectedDatabaseBackupDestinationSummary
  • get_db_home(db_home_id, region=None) -> DatabaseHome
  • list_db_systems(compartment_id=None, lifecycle_state=None, limit=None, page=None, region=None) -> list[DbSystemSummary]
  • get_db_system(db_system_id, region=None) -> DbSystem

Development

  • Code style/format/lint/test tasks are managed via Makefile:
    • make build — builds all sub-packages
    • make install — installs all sub-packages into current environment
    • make test — runs unit tests
    • make lint — runs linters
    • make format — formats code

License

Copyright (c) 2025, Oracle and/or its affiliates. Licensed under the Universal Permissive License v1.0 as shown at https://oss.oracle.com/licenses/upl.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

oracle_oci_recovery_mcp_server-2.0.0.tar.gz (105.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

oracle_oci_recovery_mcp_server-2.0.0-py3-none-any.whl (45.9 kB view details)

Uploaded Python 3

File details

Details for the file oracle_oci_recovery_mcp_server-2.0.0.tar.gz.

File metadata

  • Download URL: oracle_oci_recovery_mcp_server-2.0.0.tar.gz
  • Upload date:
  • Size: 105.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.8 {"installer":{"name":"uv","version":"0.11.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for oracle_oci_recovery_mcp_server-2.0.0.tar.gz
Algorithm Hash digest
SHA256 6cfad27e29dce89c8f0bdfddae9d9e0b81214f8c3bea24386e9e7b11da480213
MD5 68fa2b918ea207cd2d845e3c6b3ac386
BLAKE2b-256 ef961770c57c10eb69d6a64a6681f51fc6fa2f9b197b172eaab25ba8a36c354e

See more details on using hashes here.

File details

Details for the file oracle_oci_recovery_mcp_server-2.0.0-py3-none-any.whl.

File metadata

  • Download URL: oracle_oci_recovery_mcp_server-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 45.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.8 {"installer":{"name":"uv","version":"0.11.8","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for oracle_oci_recovery_mcp_server-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a4f0a79ff70e1d0be04ec9881588bf57d949c62ab8ca86dd8275b5f46ab129d7
MD5 acda6d205b67f5029948daae9eadeb13
BLAKE2b-256 d01d41bad6a40db723365c5528d0af8a3a532560fc3a9e61d37e39fd5f1afffe

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page