Skip to content

chore: more README style cleanup #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 13, 2025
Merged

chore: more README style cleanup #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/oci-api-mcp-server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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. |
Expand Down
2 changes: 2 additions & 0 deletions src/oci-compute-instance-agent-mcp-server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
3 changes: 3 additions & 0 deletions src/oci-compute-mcp-server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 |
Expand Down
3 changes: 3 additions & 0 deletions src/oci-identity-mcp-server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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. |
Expand Down
3 changes: 3 additions & 0 deletions src/oci-logging-mcp-server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 |
Expand Down
2 changes: 2 additions & 0 deletions src/oci-migration-mcp-server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
2 changes: 2 additions & 0 deletions src/oci-monitoring-mcp-server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
3 changes: 3 additions & 0 deletions src/oci-network-load-balancer-mcp-server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 |
Expand Down
3 changes: 3 additions & 0 deletions src/oci-networking-mcp-server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 |
Expand Down
3 changes: 3 additions & 0 deletions src/oci-object-storage-mcp-server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 |
Expand Down
3 changes: 3 additions & 0 deletions src/oci-registry-mcp-server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 |
Expand Down
2 changes: 2 additions & 0 deletions src/oci-resource-search-mcp-server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down
2 changes: 2 additions & 0 deletions src/oci-usage-mcp-server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down