diff --git a/src/oci-api-mcp-server/README.md b/src/oci-api-mcp-server/README.md index 6901281..6d15905 100644 --- a/src/oci-api-mcp-server/README.md +++ b/src/oci-api-mcp-server/README.md @@ -2,19 +2,32 @@ ## Overview This server provides tools to run OCI CLI commands to interact with the OCI services. -It includes resources and tools to help with OCI command execution and provide helpful information. +It includes tools to help with OCI command execution and provide helpful information. ## Running the server ```sh uv run oracle.oci-api-mcp-server ``` -## Tools and Resources -| Tool/Resource Name | Description | +## Tools +| Tool Name | Description | | --- | --- | | get_oci_command_help | Returns helpful instructions for running an OCI CLI command. Only provide the command after 'oci', do not include the string 'oci' in your command. | | run_oci_command | Runs an OCI CLI command. This tool allows you to run OCI CLI commands on the user's behalf. Only provide the command after 'oci', do not include the string 'oci' in your command. | | get_oci_commands (Resource) | Returns helpful information on various OCI services and related commands. | -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. +⚠️ **NOTE**: All actions are performed with the permissions of the configured OCI CLI profile. We advise least-privilege IAM setup, secure credential management, safe network practices, secure logging, and warn against exposing secrets. + +## Third-Party APIs + +Developers choosing to distribute a binary implementation of this project are responsible for obtaining and providing all required licenses and copyright notices for the third-party code used in order to ensure compliance with their respective open source licenses. + +## Disclaimer + +Users are responsible for their local environment and credential safety. Different language model selections may yield different results and performance. + +## License + +Copyright (c) 2025 Oracle and/or its affiliates. + +Released under the Universal Permissive License v1.0 as shown at +. diff --git a/src/oci-compute-instance-agent-mcp-server/README.md b/src/oci-compute-instance-agent-mcp-server/README.md index 985f7de..c280745 100644 --- a/src/oci-compute-instance-agent-mcp-server/README.md +++ b/src/oci-compute-instance-agent-mcp-server/README.md @@ -1,21 +1,35 @@ # OCI Compute Instance Agent MCP Server ## Overview -This server provides tools to interact with the OCI Compute Instance Agent resources. -It includes resources and tools to help with managing compute instance agents. + +This server provides tools for interacting with Oracle Cloud Infrastructure (OCI) Compute Instance Agent service. ## Running the server ```sh uv run oracle.oci-compute-instance-agent-mcp-server ``` -## Tools and Resources -| Tool/Resource Name | Description | +## Tools +| Tool Name | Description | | --- | --- | -| list_instance_agent_commands | List instance agent commands in a given compartment and instance | -| get_instance_agent_command | Get instance agent command details | -| list_instance_agent_command_executions | List instance agent command executions in a given compartment and instance | +| list_instance_agent_commands | List instance agent commands | +| get_instance_agent_command | Get instance agent command by ID | +| create_instance_agent_command | Create a new instance agent command | +| list_instance_agent_command_executions | List command executions for an instance agent command | + +⚠️ **NOTE**: All actions are performed with the permissions of the configured OCI CLI profile. We advise least-privilege IAM setup, secure credential management, safe network practices, secure logging, and warn against exposing secrets. + +## Third-Party APIs + +Developers choosing to distribute a binary implementation of this project are responsible for obtaining and providing all required licenses and copyright notices for the third-party code used in order to ensure compliance with their respective open source licenses. + +## Disclaimer + +Users are responsible for their local environment and credential safety. Different language model selections may yield different results and performance. + +## 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. +Copyright (c) 2025 Oracle and/or its affiliates. + +Released under the Universal Permissive License v1.0 as shown at +. diff --git a/src/oci-compute-mcp-server/README.md b/src/oci-compute-mcp-server/README.md index 7470ed5..4108871 100644 --- a/src/oci-compute-mcp-server/README.md +++ b/src/oci-compute-mcp-server/README.md @@ -2,15 +2,15 @@ ## Overview This server provides tools to interact with the OCI Compute resources. -It includes resources and tools to help with managing compute instances. +It includes tools to help with managing compute instances. ## Running the server ```sh uv run oracle.oci-compute-mcp-server ``` -## Tools and Resources -| Tool/Resource Name | Description | +## Tools +| Tool Name | Description | | --- | --- | | list_instances | List Instances in a given compartment | | get_instance | Get Instance with a given instance OCID | @@ -21,6 +21,20 @@ uv run oracle.oci-compute-mcp-server | get_image | Get Image with a given image OCID | | instance_action | Perform actions on a given instance | -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. +⚠️ **NOTE**: All actions are performed with the permissions of the configured OCI CLI profile. We advise least-privilege IAM setup, secure credential management, safe network practices, secure logging, and warn against exposing secrets. + +## Third-Party APIs + +Developers choosing to distribute a binary implementation of this project are responsible for obtaining and providing all required licenses and copyright notices for the third-party code used in order to ensure compliance with their respective open source licenses. + +## Disclaimer + +Users are responsible for their local environment and credential safety. Different language model selections may yield different results and performance. + +## License + +Copyright (c) 2025 Oracle and/or its affiliates. + +Released under the Universal Permissive License v1.0 as shown at +. + diff --git a/src/oci-identity-mcp-server/README.md b/src/oci-identity-mcp-server/README.md index de8604e..47dc101 100644 --- a/src/oci-identity-mcp-server/README.md +++ b/src/oci-identity-mcp-server/README.md @@ -8,7 +8,7 @@ This server provides tools to interact with the OCI Identity service. uv run oracle.oci-identity-mcp-server ``` -## Tools and Resources +## Tools | Tool Name | Description | | --- | --- | | list_compartments | List compartments in a given tenancy. | @@ -18,6 +18,20 @@ uv run oracle.oci-identity-mcp-server | create_auth_token | Create an authentication token for a user. | | get_current_user | Get current user information. | -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. +⚠️ **NOTE**: All actions are performed with the permissions of the configured OCI CLI profile. We advise least-privilege IAM setup, secure credential management, safe network practices, secure logging, and warn against exposing secrets. + +## Third-Party APIs + +Developers choosing to distribute a binary implementation of this project are responsible for obtaining and providing all required licenses and copyright notices for the third-party code used in order to ensure compliance with their respective open source licenses. + +## Disclaimer + +Users are responsible for their local environment and credential safety. Different language model selections may yield different results and performance. + +## License + +Copyright (c) 2025 Oracle and/or its affiliates. + +Released under the Universal Permissive License v1.0 as shown at +. + diff --git a/src/oci-logging-mcp-server/README.md b/src/oci-logging-mcp-server/README.md index bfbddc5..7142e70 100644 --- a/src/oci-logging-mcp-server/README.md +++ b/src/oci-logging-mcp-server/README.md @@ -2,20 +2,33 @@ ## Overview This server provides tools to interact with the OCI Logging resources. -It includes resources and tools to help with managing logging configurations. +It includes tools to help with managing logging configurations. ## Running the server ```sh uv run oracle.oci-logging-mcp-server ``` -## Tools and Resources -| Tool/Resource Name | Description | +## Tools +| Tool Name | Description | | --- | --- | | list_log_groups | List log groups in a given compartment | | list_logs | List logs in a given log group | | get_log | Get a log with a given log OCID | -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. +⚠️ **NOTE**: All actions are performed with the permissions of the configured OCI CLI profile. We advise least-privilege IAM setup, secure credential management, safe network practices, secure logging, and warn against exposing secrets. + +## Third-Party APIs + +Developers choosing to distribute a binary implementation of this project are responsible for obtaining and providing all required licenses and copyright notices for the third-party code used in order to ensure compliance with their respective open source licenses. + +## Disclaimer + +Users are responsible for their local environment and credential safety. Different language model selections may yield different results and performance. + +## License + +Copyright (c) 2025 Oracle and/or its affiliates. + +Released under the Universal Permissive License v1.0 as shown at +. diff --git a/src/oci-migration-mcp-server/README.md b/src/oci-migration-mcp-server/README.md index fe1ce58..66fd429 100644 --- a/src/oci-migration-mcp-server/README.md +++ b/src/oci-migration-mcp-server/README.md @@ -1,20 +1,34 @@ # OCI Migration MCP Server ## Overview -This server provides tools to interact with the OCI Migration resources. -It includes resources and tools to help with managing migration projects. + +This server provides tools for interacting with Oracle Cloud Infrastructure (OCI) Migration service. ## Running the server ```sh uv run oracle.oci-migration-mcp-server ``` -## Tools and Resources -| Tool/Resource Name | Description | +## Tools +| Tool Name | Description | | --- | --- | -| get_migration | Get details for a specific Migration Project by OCID | -| list_migrations | List Migration Projects for a compartment, optionally filtered by lifecycle state | +| list_migrations | List migrations in the tenancy | +| get_migration | Get migration by ID | + + +⚠️ **NOTE**: All actions are performed with the permissions of the configured OCI CLI profile. We advise least-privilege IAM setup, secure credential management, safe network practices, secure logging, and warn against exposing secrets. + +## Third-Party APIs + +Developers choosing to distribute a binary implementation of this project are responsible for obtaining and providing all required licenses and copyright notices for the third-party code used in order to ensure compliance with their respective open source licenses. + +## Disclaimer + +Users are responsible for their local environment and credential safety. Different language model selections may yield different results and performance. + +## 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. +Copyright (c) 2025 Oracle and/or its affiliates. + +Released under the Universal Permissive License v1.0 as shown at +. diff --git a/src/oci-monitoring-mcp-server/README.md b/src/oci-monitoring-mcp-server/README.md index a3dfe33..f4f5320 100644 --- a/src/oci-monitoring-mcp-server/README.md +++ b/src/oci-monitoring-mcp-server/README.md @@ -1,20 +1,34 @@ # OCI Monitoring MCP Server ## Overview -This server provides tools to interact with the OCI Monitoring resources. -It includes resources and tools to help with monitoring configurations. + +This server provides tools for interacting with Oracle Cloud Infrastructure (OCI) Monitoring service. ## Running the server ```sh uv run oracle.oci-monitoring-mcp-server ``` -## Tools and Resources -| Tool/Resource Name | Description | +## Tools +| Tool Name | Description | | --- | --- | -| get_compute_metrics | Retrieve compute metrics for a given compartment and time range | -| list_alarms | List alarms in a given compartment | +| list_metrics | List metrics in the tenancy | +| get_metric | Get metric by name | + + +⚠️ **NOTE**: All actions are performed with the permissions of the configured OCI CLI profile. We advise least-privilege IAM setup, secure credential management, safe network practices, secure logging, and warn against exposing secrets. + +## Third-Party APIs + +Developers choosing to distribute a binary implementation of this project are responsible for obtaining and providing all required licenses and copyright notices for the third-party code used in order to ensure compliance with their respective open source licenses. + +## Disclaimer + +Users are responsible for their local environment and credential safety. Different language model selections may yield different results and performance. + +## 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. +Copyright (c) 2025 Oracle and/or its affiliates. + +Released under the Universal Permissive License v1.0 as shown at +. diff --git a/src/oci-network-load-balancer-mcp-server/README.md b/src/oci-network-load-balancer-mcp-server/README.md index 6c860db..be16b6a 100644 --- a/src/oci-network-load-balancer-mcp-server/README.md +++ b/src/oci-network-load-balancer-mcp-server/README.md @@ -2,15 +2,15 @@ ## Overview This server provides tools to interact with the OCI Network Load Balancer resources. -It includes resources and tools to help with managing network load balancers. +It includes tools to help with managing network load balancers. ## Running the server ```sh uv run oracle.oci-network-load-balancer-mcp-server ``` -## Tools and Resources -| Tool/Resource Name | Description | +## Tools +| Tool Name | Description | | --- | --- | | list_network_load_balancers | List network load balancers in a given compartment | | get_network_load_balancer | Get network load balancer details | @@ -21,6 +21,19 @@ uv run oracle.oci-network-load-balancer-mcp-server | list_network_load_balancer_backends | List backends in a given backend set and network load balancer | | get_network_load_balancer_backend | Get a backend with a given backend name from a backend set and network load balancer | -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. +⚠️ **NOTE**: All actions are performed with the permissions of the configured OCI CLI profile. We advise least-privilege IAM setup, secure credential management, safe network practices, secure logging, and warn against exposing secrets. + +## Third-Party APIs + +Developers choosing to distribute a binary implementation of this project are responsible for obtaining and providing all required licenses and copyright notices for the third-party code used in order to ensure compliance with their respective open source licenses. + +## Disclaimer + +Users are responsible for their local environment and credential safety. Different language model selections may yield different results and performance. + +## License + +Copyright (c) 2025 Oracle and/or its affiliates. + +Released under the Universal Permissive License v1.0 as shown at +. diff --git a/src/oci-networking-mcp-server/README.md b/src/oci-networking-mcp-server/README.md index 2e3c379..2c47bed 100644 --- a/src/oci-networking-mcp-server/README.md +++ b/src/oci-networking-mcp-server/README.md @@ -2,15 +2,15 @@ ## Overview This server provides tools to interact with the OCI Networking resources. -It includes resources and tools to help with managing network configurations. +It includes tools to help with managing network configurations. ## Running the server ```sh uv run oracle.oci-networking-mcp-server ``` -## Tools and Resources -| Tool/Resource Name | Description | +## Tools +| Tool Name | Description | | --- | --- | | list_vcns | List Virtual Cloud Networks (VCNs) in a given compartment | | get_vcn | Get a VCN with a given VCN OCID | @@ -24,6 +24,19 @@ uv run oracle.oci-networking-mcp-server | list_network_security_groups | List network security groups in a given compartment and VCN | | get_network_security_group | Get a network security group with a given NSG OCID | -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. +⚠️ **NOTE**: All actions are performed with the permissions of the configured OCI CLI profile. We advise least-privilege IAM setup, secure credential management, safe network practices, secure logging, and warn against exposing secrets. + +## Third-Party APIs + +Developers choosing to distribute a binary implementation of this project are responsible for obtaining and providing all required licenses and copyright notices for the third-party code used in order to ensure compliance with their respective open source licenses. + +## Disclaimer + +Users are responsible for their local environment and credential safety. Different language model selections may yield different results and performance. + +## License + +Copyright (c) 2025 Oracle and/or its affiliates. + +Released under the Universal Permissive License v1.0 as shown at +. diff --git a/src/oci-object-storage-mcp-server/README.md b/src/oci-object-storage-mcp-server/README.md index 6149c45..6e1de85 100644 --- a/src/oci-object-storage-mcp-server/README.md +++ b/src/oci-object-storage-mcp-server/README.md @@ -2,15 +2,15 @@ ## Overview This server provides tools to interact with the OCI Object Storage resources. -It includes resources and tools to help with managing object storage configurations. +It includes tools to help with managing object storage configurations. ## Running the server ```sh uv run oracle.oci-object-storage-mcp-server ``` -## Tools and Resources -| Tool/Resource Name | Description | +## Tools +| Tool Name | Description | | --- | --- | | get_namespace | Get the object storage namespace for the tenancy | | list_buckets | List object storage buckets in a given compartment | @@ -20,6 +20,20 @@ uv run oracle.oci-object-storage-mcp-server | get_object | Get a specific object from an object storage bucket | | upload_object | Upload an object to an object storage bucket | -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. +⚠️ **NOTE**: All actions are performed with the permissions of the configured OCI CLI profile. We advise least-privilege IAM setup, secure credential management, safe network practices, secure logging, and warn against exposing secrets. + +## Third-Party APIs + +Developers choosing to distribute a binary implementation of this project are responsible for obtaining and providing all required licenses and copyright notices for the third-party code used in order to ensure compliance with their respective open source licenses. + +## Disclaimer + +Users are responsible for their local environment and credential safety. Different language model selections may yield different results and performance. + +## License + +Copyright (c) 2025 Oracle and/or its affiliates. + +Released under the Universal Permissive License v1.0 as shown at +. + diff --git a/src/oci-registry-mcp-server/README.md b/src/oci-registry-mcp-server/README.md index 4846687..f022519 100644 --- a/src/oci-registry-mcp-server/README.md +++ b/src/oci-registry-mcp-server/README.md @@ -2,21 +2,34 @@ ## Overview This server provides tools to interact with the OCI Registry resources. -It includes resources and tools to help with managing container repositories. +It includes tools to help with managing container repositories. ## Running the server ```sh uv run oracle.oci-registry-mcp-server ``` -## Tools and Resources -| Tool/Resource Name | Description | +## Tools +| Tool Name | Description | | --- | --- | | create_container_repository | Create a new container repository | | list_container_repositories | List container repositories in a given compartment | | get_container_repo_details | Get details for a specific container repository | | delete_container_repository | Delete a container repository | -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. +⚠️ **NOTE**: All actions are performed with the permissions of the configured OCI CLI profile. We advise least-privilege IAM setup, secure credential management, safe network practices, secure logging, and warn against exposing secrets. + +## Third-Party APIs + +Developers choosing to distribute a binary implementation of this project are responsible for obtaining and providing all required licenses and copyright notices for the third-party code used in order to ensure compliance with their respective open source licenses. + +## Disclaimer + +Users are responsible for their local environment and credential safety. Different language model selections may yield different results and performance. + +## License + +Copyright (c) 2025 Oracle and/or its affiliates. + +Released under the Universal Permissive License v1.0 as shown at +. diff --git a/src/oci-resource-search-mcp-server/README.md b/src/oci-resource-search-mcp-server/README.md index 7774d1f..a7feebc 100644 --- a/src/oci-resource-search-mcp-server/README.md +++ b/src/oci-resource-search-mcp-server/README.md @@ -1,21 +1,33 @@ # OCI Resource Search MCP Server ## Overview -This server provides tools to search for OCI resources. + +This server provides tools for interacting with Oracle Cloud Infrastructure (OCI) Resource Search service. ## Running the server ```sh uv run oracle.oci-resource-search-mcp-server ``` -## Tools and Resources +## Tools | Tool Name | Description | | --- | --- | -| list_all_resources | List all resources in a given compartment. | -| search_resources | Search for resources by display name. | -| search_resources_free_form | Search for resources using a free-form search string. | -| list_resource_types | List all supported OCI resource types. | - -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. +| search_resources | Search for resources in the tenancy | + + +⚠️ **NOTE**: All actions are performed with the permissions of the configured OCI CLI profile. We advise least-privilege IAM setup, secure credential management, safe network practices, secure logging, and warn against exposing secrets. + +## Third-Party APIs + +Developers choosing to distribute a binary implementation of this project are responsible for obtaining and providing all required licenses and copyright notices for the third-party code used in order to ensure compliance with their respective open source licenses. + +## Disclaimer + +Users are responsible for their local environment and credential safety. Different language model selections may yield different results and performance. + +## License + +Copyright (c) 2025 Oracle and/or its affiliates. + +Released under the Universal Permissive License v1.0 as shown at +. diff --git a/src/oci-usage-mcp-server/README.md b/src/oci-usage-mcp-server/README.md index 4be3645..2821e05 100644 --- a/src/oci-usage-mcp-server/README.md +++ b/src/oci-usage-mcp-server/README.md @@ -1,18 +1,33 @@ # OCI Usage MCP Server ## Overview -This server provides tools to interact with the OCI Usage service. + +This server provides tools for interacting with Oracle Cloud Infrastructure (OCI) Usage service. ## Running the server ```sh uv run oracle.oci-usage-mcp-server ``` -## Tools and Resources +## Tools | Tool Name | Description | | --- | --- | -| get_summarized_usage | Get summarized usage for a given tenancy and time range. | +| list_usage_reports | List usage reports in the tenancy | +| get_usage_report | Get usage report by ID | + +⚠️ **NOTE**: All actions are performed with the permissions of the configured OCI CLI profile. We advise least-privilege IAM setup, secure credential management, safe network practices, secure logging, and warn against exposing secrets. + +## Third-Party APIs + +Developers choosing to distribute a binary implementation of this project are responsible for obtaining and providing all required licenses and copyright notices for the third-party code used in order to ensure compliance with their respective open source licenses. + +## Disclaimer + +Users are responsible for their local environment and credential safety. Different language model selections may yield different results and performance. + +## 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. +Copyright (c) 2025 Oracle and/or its affiliates. + +Released under the Universal Permissive License v1.0 as shown at +.