From 5e012dde3cd8ee2e4e3c14d1c84347e15b7c93cf Mon Sep 17 00:00:00 2001 From: Richard Gebhardt Date: Sun, 12 Oct 2025 17:48:29 -0700 Subject: [PATCH] chore: more README style cleanup Signed-off-by: Richard Gebhardt --- src/oci-api-mcp-server/README.md | 3 +++ src/oci-compute-instance-agent-mcp-server/README.md | 2 ++ src/oci-compute-mcp-server/README.md | 3 +++ src/oci-identity-mcp-server/README.md | 3 +++ src/oci-logging-mcp-server/README.md | 3 +++ src/oci-migration-mcp-server/README.md | 2 ++ src/oci-monitoring-mcp-server/README.md | 2 ++ src/oci-network-load-balancer-mcp-server/README.md | 3 +++ src/oci-networking-mcp-server/README.md | 3 +++ src/oci-object-storage-mcp-server/README.md | 3 +++ src/oci-registry-mcp-server/README.md | 3 +++ src/oci-resource-search-mcp-server/README.md | 2 ++ src/oci-usage-mcp-server/README.md | 2 ++ 13 files changed, 34 insertions(+) diff --git a/src/oci-api-mcp-server/README.md b/src/oci-api-mcp-server/README.md index 6d15905..160157b 100644 --- a/src/oci-api-mcp-server/README.md +++ b/src/oci-api-mcp-server/README.md @@ -1,14 +1,17 @@ # OCI API MCP Server ## Overview + This server provides tools to run OCI CLI commands to interact with the OCI services. 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 + | 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. | diff --git a/src/oci-compute-instance-agent-mcp-server/README.md b/src/oci-compute-instance-agent-mcp-server/README.md index c280745..19a53ae 100644 --- a/src/oci-compute-instance-agent-mcp-server/README.md +++ b/src/oci-compute-instance-agent-mcp-server/README.md @@ -5,11 +5,13 @@ 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 + | Tool Name | Description | | --- | --- | | list_instance_agent_commands | List instance agent commands | diff --git a/src/oci-compute-mcp-server/README.md b/src/oci-compute-mcp-server/README.md index 4108871..0753779 100644 --- a/src/oci-compute-mcp-server/README.md +++ b/src/oci-compute-mcp-server/README.md @@ -1,15 +1,18 @@ # OCI Compute MCP Server ## Overview + This server provides tools to interact with the OCI Compute resources. It includes tools to help with managing compute instances. ## Running the server + ```sh uv run oracle.oci-compute-mcp-server ``` ## Tools + | Tool Name | Description | | --- | --- | | list_instances | List Instances in a given compartment | diff --git a/src/oci-identity-mcp-server/README.md b/src/oci-identity-mcp-server/README.md index 47dc101..3455f94 100644 --- a/src/oci-identity-mcp-server/README.md +++ b/src/oci-identity-mcp-server/README.md @@ -1,14 +1,17 @@ # 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 + | Tool Name | Description | | --- | --- | | list_compartments | List compartments in a given tenancy. | diff --git a/src/oci-logging-mcp-server/README.md b/src/oci-logging-mcp-server/README.md index 7142e70..a0468f4 100644 --- a/src/oci-logging-mcp-server/README.md +++ b/src/oci-logging-mcp-server/README.md @@ -1,15 +1,18 @@ # OCI Logging MCP Server ## Overview + This server provides tools to interact with the OCI Logging resources. It includes tools to help with managing logging configurations. ## Running the server + ```sh uv run oracle.oci-logging-mcp-server ``` ## Tools + | Tool Name | Description | | --- | --- | | list_log_groups | List log groups in a given compartment | diff --git a/src/oci-migration-mcp-server/README.md b/src/oci-migration-mcp-server/README.md index 66fd429..10c095a 100644 --- a/src/oci-migration-mcp-server/README.md +++ b/src/oci-migration-mcp-server/README.md @@ -5,11 +5,13 @@ 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 + | Tool Name | Description | | --- | --- | | list_migrations | List migrations in the tenancy | diff --git a/src/oci-monitoring-mcp-server/README.md b/src/oci-monitoring-mcp-server/README.md index f4f5320..0e4057c 100644 --- a/src/oci-monitoring-mcp-server/README.md +++ b/src/oci-monitoring-mcp-server/README.md @@ -5,11 +5,13 @@ 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 + | Tool Name | Description | | --- | --- | | list_metrics | List metrics in the tenancy | diff --git a/src/oci-network-load-balancer-mcp-server/README.md b/src/oci-network-load-balancer-mcp-server/README.md index be16b6a..eeb5cda 100644 --- a/src/oci-network-load-balancer-mcp-server/README.md +++ b/src/oci-network-load-balancer-mcp-server/README.md @@ -1,15 +1,18 @@ # OCI Network Load Balancer MCP Server ## Overview + This server provides tools to interact with the OCI Network Load Balancer resources. It includes tools to help with managing network load balancers. ## Running the server + ```sh uv run oracle.oci-network-load-balancer-mcp-server ``` ## Tools + | Tool Name | Description | | --- | --- | | list_network_load_balancers | List network load balancers in a given compartment | diff --git a/src/oci-networking-mcp-server/README.md b/src/oci-networking-mcp-server/README.md index 2c47bed..b691eb6 100644 --- a/src/oci-networking-mcp-server/README.md +++ b/src/oci-networking-mcp-server/README.md @@ -1,15 +1,18 @@ # OCI Networking MCP Server ## Overview + This server provides tools to interact with the OCI Networking resources. It includes tools to help with managing network configurations. ## Running the server + ```sh uv run oracle.oci-networking-mcp-server ``` ## Tools + | Tool Name | Description | | --- | --- | | list_vcns | List Virtual Cloud Networks (VCNs) in a given compartment | diff --git a/src/oci-object-storage-mcp-server/README.md b/src/oci-object-storage-mcp-server/README.md index 6e1de85..2fa43be 100644 --- a/src/oci-object-storage-mcp-server/README.md +++ b/src/oci-object-storage-mcp-server/README.md @@ -1,15 +1,18 @@ # OCI Object Storage MCP Server ## Overview + This server provides tools to interact with the OCI Object Storage resources. It includes tools to help with managing object storage configurations. ## Running the server + ```sh uv run oracle.oci-object-storage-mcp-server ``` ## Tools + | Tool Name | Description | | --- | --- | | get_namespace | Get the object storage namespace for the tenancy | diff --git a/src/oci-registry-mcp-server/README.md b/src/oci-registry-mcp-server/README.md index f022519..ea3fc0a 100644 --- a/src/oci-registry-mcp-server/README.md +++ b/src/oci-registry-mcp-server/README.md @@ -1,15 +1,18 @@ # OCI Registry MCP Server ## Overview + This server provides tools to interact with the OCI Registry resources. It includes tools to help with managing container repositories. ## Running the server + ```sh uv run oracle.oci-registry-mcp-server ``` ## Tools + | Tool Name | Description | | --- | --- | | create_container_repository | Create a new container repository | diff --git a/src/oci-resource-search-mcp-server/README.md b/src/oci-resource-search-mcp-server/README.md index a7feebc..5c40e04 100644 --- a/src/oci-resource-search-mcp-server/README.md +++ b/src/oci-resource-search-mcp-server/README.md @@ -5,11 +5,13 @@ 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 + | Tool Name | Description | | --- | --- | | search_resources | Search for resources in the tenancy | diff --git a/src/oci-usage-mcp-server/README.md b/src/oci-usage-mcp-server/README.md index 2821e05..9d0871c 100644 --- a/src/oci-usage-mcp-server/README.md +++ b/src/oci-usage-mcp-server/README.md @@ -5,11 +5,13 @@ 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 + | Tool Name | Description | | --- | --- | | list_usage_reports | List usage reports in the tenancy |