diff --git a/src/oci-api-mcp-server/README.md b/src/oci-api-mcp-server/README.md index b7cec10e..69012816 100644 --- a/src/oci-api-mcp-server/README.md +++ b/src/oci-api-mcp-server/README.md @@ -1,32 +1,19 @@ # OCI API MCP Server ## Overview -This server provides tools to run OCI CLI commands to interact with OCI services. +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. ## Running the server -Please follow the guidelines under [Quickstart](../../README.md#quick-start) +```sh +uv run oracle.oci-api-mcp-server +``` ## Tools and Resources - -### 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. - -## Tests -The tests for this server are located in `oracle/oci_api_mcp_server/tests/test_oci_api_tools.py`. -They cover various scenarios for the tools provided by the server, including success and failure cases. - -## Implementation Details -The server is implemented in `oracle/oci_api_mcp_server/server.py`. -It uses the FastMCP framework to provide the tools and resources. +| Tool/Resource 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 diff --git a/src/oci-compute-instance-agent-mcp-server/README.md b/src/oci-compute-instance-agent-mcp-server/README.md index 5394d801..985f7ded 100644 --- a/src/oci-compute-instance-agent-mcp-server/README.md +++ b/src/oci-compute-instance-agent-mcp-server/README.md @@ -1 +1,21 @@ # 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. + +## Running the server +```sh +uv run oracle.oci-compute-instance-agent-mcp-server +``` + +## Tools and Resources +| Tool/Resource 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 | + +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. diff --git a/src/oci-compute-mcp-server/README.md b/src/oci-compute-mcp-server/README.md index 0a4ceb81..7470ed58 100644 --- a/src/oci-compute-mcp-server/README.md +++ b/src/oci-compute-mcp-server/README.md @@ -1 +1,26 @@ -# OCI Compute Service MCP server \ No newline at end of file +# OCI Compute MCP Server + +## Overview +This server provides tools to interact with the OCI Compute resources. +It includes resources and 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 | +| --- | --- | +| list_instances | List Instances in a given compartment | +| get_instance | Get Instance with a given instance OCID | +| launch_instance | Create a new instance | +| terminate_instance | Terminate an instance | +| update_instance | Update instance configuration | +| list_images | List images in a given compartment | +| 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. diff --git a/src/oci-identity-mcp-server/README.md b/src/oci-identity-mcp-server/README.md index fd874d3c..de8604e5 100644 --- a/src/oci-identity-mcp-server/README.md +++ b/src/oci-identity-mcp-server/README.md @@ -1 +1,23 @@ -# OCI Identity Service MCP server +# OCI Identity MCP Server + +## Overview +This server provides tools to interact with the OCI Identity service. + +## Running the server +```sh +uv run oracle.oci-identity-mcp-server +``` + +## Tools and Resources +| Tool Name | Description | +| --- | --- | +| list_compartments | List compartments in a given tenancy. | +| get_tenancy_info | Get tenancy information. | +| list_availability_domains | List availability domains in a given tenancy. | +| get_current_tenancy | Get current tenancy information. | +| 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. diff --git a/src/oci-logging-mcp-server/README.md b/src/oci-logging-mcp-server/README.md index f7bd2b34..bfbddc5c 100644 --- a/src/oci-logging-mcp-server/README.md +++ b/src/oci-logging-mcp-server/README.md @@ -1 +1,21 @@ -# OCI Logging Service MCP server +# OCI Logging MCP Server + +## Overview +This server provides tools to interact with the OCI Logging resources. +It includes resources and 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 | +| --- | --- | +| 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. diff --git a/src/oci-migration-mcp-server/README.md b/src/oci-migration-mcp-server/README.md index e69de29b..fe1ce583 100644 --- a/src/oci-migration-mcp-server/README.md +++ b/src/oci-migration-mcp-server/README.md @@ -0,0 +1,20 @@ +# 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. + +## Running the server +```sh +uv run oracle.oci-migration-mcp-server +``` + +## Tools and Resources +| Tool/Resource 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 | + +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. diff --git a/src/oci-monitoring-mcp-server/README.md b/src/oci-monitoring-mcp-server/README.md index 30bf18fc..a3dfe333 100644 --- a/src/oci-monitoring-mcp-server/README.md +++ b/src/oci-monitoring-mcp-server/README.md @@ -1 +1,20 @@ -# OCI Monitoring Service MCP server +# 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. + +## Running the server +```sh +uv run oracle.oci-monitoring-mcp-server +``` + +## Tools and Resources +| Tool/Resource Name | Description | +| --- | --- | +| get_compute_metrics | Retrieve compute metrics for a given compartment and time range | +| list_alarms | List alarms in a given compartment | + +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. diff --git a/src/oci-network-load-balancer-mcp-server/README.md b/src/oci-network-load-balancer-mcp-server/README.md index 3b877be9..6c860db7 100644 --- a/src/oci-network-load-balancer-mcp-server/README.md +++ b/src/oci-network-load-balancer-mcp-server/README.md @@ -1 +1,26 @@ -# OCI Network Load Balancer MCP server \ No newline at end of file +# OCI Network Load Balancer MCP Server + +## 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. + +## Running the server +```sh +uv run oracle.oci-network-load-balancer-mcp-server +``` + +## Tools and Resources +| Tool/Resource Name | Description | +| --- | --- | +| list_network_load_balancers | List network load balancers in a given compartment | +| get_network_load_balancer | Get network load balancer details | +| list_network_load_balancer_listeners | List listeners in a given network load balancer | +| get_network_load_balancer_listener | Get a listener with a given listener name from a network load balancer | +| list_network_load_balancer_backend_sets | List backend sets in a given network load balancer | +| get_network_load_balancer_backend_set | Get a backend set with a given backend set name from a network load balancer | +| 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. diff --git a/src/oci-networking-mcp-server/README.md b/src/oci-networking-mcp-server/README.md index 157eba2f..2e3c3794 100644 --- a/src/oci-networking-mcp-server/README.md +++ b/src/oci-networking-mcp-server/README.md @@ -1 +1,29 @@ -# OCI Networking Service MCP server +# OCI Networking MCP Server + +## Overview +This server provides tools to interact with the OCI Networking resources. +It includes resources and 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 | +| --- | --- | +| list_vcns | List Virtual Cloud Networks (VCNs) in a given compartment | +| get_vcn | Get a VCN with a given VCN OCID | +| delete_vcn | Delete a VCN with a given VCN OCID | +| create_vcn | Create a new VCN | +| list_subnets | List subnets in a given compartment and VCN | +| get_subnet | Get a subnet with a given subnet OCID | +| create_subnet | Create a new subnet | +| list_security_lists | List security lists in a given VCN and compartment | +| get_security_list | Get a security list with a given security list OCID | +| 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. diff --git a/src/oci-object-storage-mcp-server/README.md b/src/oci-object-storage-mcp-server/README.md index 230c9ae1..6149c459 100644 --- a/src/oci-object-storage-mcp-server/README.md +++ b/src/oci-object-storage-mcp-server/README.md @@ -1,18 +1,25 @@ -# OCI Object Storage Service MCP server +# OCI Object Storage MCP Server -# Queries -1. get namespace for my compartment: compartment_id -2. use compartment comp_id for all communications -3. list my buckets -4. list objects in the bucket bucket_name -5. list objects with prefix prefix_name in bucket bucket_name -6. list versions of object object_name in bucket bucket_name +## 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. +## Running the server +```sh +uv run oracle.oci-object-storage-mcp-server +``` ----- - -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. - +## Tools and Resources +| Tool/Resource Name | Description | +| --- | --- | +| get_namespace | Get the object storage namespace for the tenancy | +| list_buckets | List object storage buckets in a given compartment | +| get_bucket_details | Get details for a specific object storage bucket | +| list_objects | List objects in a given object storage bucket | +| list_object_versions | List object versions in a given object storage bucket | +| 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. diff --git a/src/oci-registry-mcp-server/README.md b/src/oci-registry-mcp-server/README.md index 3c05e930..4846687d 100644 --- a/src/oci-registry-mcp-server/README.md +++ b/src/oci-registry-mcp-server/README.md @@ -1 +1,22 @@ -# OCI Registry Service MCP server +# OCI Registry MCP Server + +## Overview +This server provides tools to interact with the OCI Registry resources. +It includes resources and 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 | +| --- | --- | +| 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. diff --git a/src/oci-resource-search-mcp-server/README.md b/src/oci-resource-search-mcp-server/README.md index da006ee5..7774d1f4 100644 --- a/src/oci-resource-search-mcp-server/README.md +++ b/src/oci-resource-search-mcp-server/README.md @@ -1 +1,21 @@ -# OCI Resource Search Service MCP server +# OCI Resource Search MCP Server + +## Overview +This server provides tools to search for OCI resources. + +## Running the server +```sh +uv run oracle.oci-resource-search-mcp-server +``` + +## Tools and Resources +| 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. diff --git a/src/oci-usage-mcp-server/README.md b/src/oci-usage-mcp-server/README.md index 30bf18fc..4be3645d 100644 --- a/src/oci-usage-mcp-server/README.md +++ b/src/oci-usage-mcp-server/README.md @@ -1 +1,18 @@ -# OCI Monitoring Service MCP server +# OCI Usage MCP Server + +## Overview +This server provides tools to interact with the OCI Usage service. + +## Running the server +```sh +uv run oracle.oci-usage-mcp-server +``` + +## Tools and Resources +| Tool Name | Description | +| --- | --- | +| get_summarized_usage | Get summarized usage for a given tenancy and time range. | + +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.