Skip to content

Commit ecbffa9

Browse files
gebhardtrgebhardtr
committed
chore: fix READMEs
Signed-off-by: Richard Gebhardt <[email protected]>
1 parent b0aa621 commit ecbffa9

File tree

13 files changed

+276
-45
lines changed

13 files changed

+276
-45
lines changed

‎src/oci-api-mcp-server/README.md‎

Lines changed: 9 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,19 @@
11
# OCI API MCP Server
22

33
## Overview
4-
This server provides tools to run OCI CLI commands to interact with OCI services.
4+
This server provides tools to run OCI CLI commands to interact with the OCI services.
55
It includes resources and tools to help with OCI command execution and provide helpful information.
66

77
## Running the server
8-
Please follow the guidelines under [Quickstart](../../README.md#quick-start)
8+
```sh
9+
uv run oracle.oci-api-mcp-server
10+
```
911
## Tools and Resources
10-
11-
### get_oci_command_help
12-
Returns helpful instructions for running an OCI CLI command.
13-
Only provide the command after 'oci', do not include the string 'oci' in your command.
14-
15-
### run_oci_command
16-
Runs an OCI CLI command.
17-
This tool allows you to run OCI CLI commands on the user's behalf.
18-
Only provide the command after 'oci', do not include the string 'oci' in your command.
19-
20-
### get_oci_commands (Resource)
21-
Returns helpful information on various OCI services and related commands.
22-
23-
## Tests
24-
The tests for this server are located in `oracle/oci_api_mcp_server/tests/test_oci_api_tools.py`.
25-
They cover various scenarios for the tools provided by the server, including success and failure cases.
26-
27-
## Implementation Details
28-
The server is implemented in `oracle/oci_api_mcp_server/server.py`.
29-
It uses the FastMCP framework to provide the tools and resources.
12+
| Tool/Resource Name | Description |
13+
| --- | --- |
14+
| 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. |
15+
| 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. |
16+
| get_oci_commands (Resource) | Returns helpful information on various OCI services and related commands. |
3017

3118
<span style="font-size: small;">Copyright (c) 2025, Oracle and/or its affiliates.
3219
Licensed under the Universal Permissive License v1.0 as shown at

‎src/oci-compute-instance-agent-mcp-server/README.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,21 @@
11
# OCI Compute Instance Agent MCP Server
2+
3+
## Overview
4+
This server provides tools to interact with the OCI Compute Instance Agent resources.
5+
It includes resources and tools to help with managing compute instance agents.
6+
7+
## Running the server
8+
```sh
9+
uv run oracle.oci-compute-instance-agent-mcp-server
10+
```
11+
12+
## Tools and Resources
13+
| Tool/Resource Name | Description |
14+
| --- | --- |
15+
| list_instance_agent_commands | List instance agent commands in a given compartment and instance |
16+
| get_instance_agent_command | Get instance agent command details |
17+
| list_instance_agent_command_executions | List instance agent command executions in a given compartment and instance |
18+
19+
<span style="font-size: small;">Copyright (c) 2025, Oracle and/or its affiliates.
20+
Licensed under the Universal Permissive License v1.0 as shown at
21+
https://oss.oracle.com/licenses/upl.</span>

‎src/oci-compute-mcp-server/README.md‎

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,26 @@
1-
# OCI Compute Service MCP server
1+
# OCI Compute MCP Server
2+
3+
## Overview
4+
This server provides tools to interact with the OCI Compute resources.
5+
It includes resources and tools to help with managing compute instances.
6+
7+
## Running the server
8+
```sh
9+
uv run oracle.oci-compute-mcp-server
10+
```
11+
12+
## Tools and Resources
13+
| Tool/Resource Name | Description |
14+
| --- | --- |
15+
| list_instances | List Instances in a given compartment |
16+
| get_instance | Get Instance with a given instance OCID |
17+
| launch_instance | Create a new instance |
18+
| terminate_instance | Terminate an instance |
19+
| update_instance | Update instance configuration |
20+
| list_images | List images in a given compartment |
21+
| get_image | Get Image with a given image OCID |
22+
| instance_action | Perform actions on a given instance |
23+
24+
<span style="font-size: small;">Copyright (c) 2025, Oracle and/or its affiliates.
25+
Licensed under the Universal Permissive License v1.0 as shown at
26+
https://oss.oracle.com/licenses/upl.</span>

‎src/oci-identity-mcp-server/README.md‎

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,23 @@
1-
# OCI Identity Service MCP server
1+
# OCI Identity MCP Server
2+
3+
## Overview
4+
This server provides tools to interact with the OCI Identity service.
5+
6+
## Running the server
7+
```sh
8+
uv run oracle.oci-identity-mcp-server
9+
```
10+
11+
## Tools and Resources
12+
| Tool Name | Description |
13+
| --- | --- |
14+
| list_compartments | List compartments in a given tenancy. |
15+
| get_tenancy_info | Get tenancy information. |
16+
| list_availability_domains | List availability domains in a given tenancy. |
17+
| get_current_tenancy | Get current tenancy information. |
18+
| create_auth_token | Create an authentication token for a user. |
19+
| get_current_user | Get current user information. |
20+
21+
<span style="font-size: small;">Copyright (c) 2025, Oracle and/or its affiliates.
22+
Licensed under the Universal Permissive License v1.0 as shown at
23+
https://oss.oracle.com/licenses/upl.</span>

‎src/oci-logging-mcp-server/README.md‎

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,21 @@
1-
# OCI Logging Service MCP server
1+
# OCI Logging MCP Server
2+
3+
## Overview
4+
This server provides tools to interact with the OCI Logging resources.
5+
It includes resources and tools to help with managing logging configurations.
6+
7+
## Running the server
8+
```sh
9+
uv run oracle.oci-logging-mcp-server
10+
```
11+
12+
## Tools and Resources
13+
| Tool/Resource Name | Description |
14+
| --- | --- |
15+
| list_log_groups | List log groups in a given compartment |
16+
| list_logs | List logs in a given log group |
17+
| get_log | Get a log with a given log OCID |
18+
19+
<span style="font-size: small;">Copyright (c) 2025, Oracle and/or its affiliates.
20+
Licensed under the Universal Permissive License v1.0 as shown at
21+
https://oss.oracle.com/licenses/upl.</span>

‎src/oci-migration-mcp-server/README.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# OCI Migration MCP Server
2+
3+
## Overview
4+
This server provides tools to interact with the OCI Migration resources.
5+
It includes resources and tools to help with managing migration projects.
6+
7+
## Running the server
8+
```sh
9+
uv run oracle.oci-migration-mcp-server
10+
```
11+
12+
## Tools and Resources
13+
| Tool/Resource Name | Description |
14+
| --- | --- |
15+
| get_migration | Get details for a specific Migration Project by OCID |
16+
| list_migrations | List Migration Projects for a compartment, optionally filtered by lifecycle state |
17+
18+
<span style="font-size: small;">Copyright (c) 2025, Oracle and/or its affiliates.
19+
Licensed under the Universal Permissive License v1.0 as shown at
20+
https://oss.oracle.com/licenses/upl.</span>

‎src/oci-monitoring-mcp-server/README.md‎

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,20 @@
1-
# OCI Monitoring Service MCP server
1+
# OCI Monitoring MCP Server
2+
3+
## Overview
4+
This server provides tools to interact with the OCI Monitoring resources.
5+
It includes resources and tools to help with monitoring configurations.
6+
7+
## Running the server
8+
```sh
9+
uv run oracle.oci-monitoring-mcp-server
10+
```
11+
12+
## Tools and Resources
13+
| Tool/Resource Name | Description |
14+
| --- | --- |
15+
| get_compute_metrics | Retrieve compute metrics for a given compartment and time range |
16+
| list_alarms | List alarms in a given compartment |
17+
18+
<span style="font-size: small;">Copyright (c) 2025, Oracle and/or its affiliates.
19+
Licensed under the Universal Permissive License v1.0 as shown at
20+
https://oss.oracle.com/licenses/upl.</span>

‎src/oci-network-load-balancer-mcp-server/README.md‎

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,26 @@
1-
# OCI Network Load Balancer MCP server
1+
# OCI Network Load Balancer MCP Server
2+
3+
## Overview
4+
This server provides tools to interact with the OCI Network Load Balancer resources.
5+
It includes resources and tools to help with managing network load balancers.
6+
7+
## Running the server
8+
```sh
9+
uv run oracle.oci-network-load-balancer-mcp-server
10+
```
11+
12+
## Tools and Resources
13+
| Tool/Resource Name | Description |
14+
| --- | --- |
15+
| list_network_load_balancers | List network load balancers in a given compartment |
16+
| get_network_load_balancer | Get network load balancer details |
17+
| list_network_load_balancer_listeners | List listeners in a given network load balancer |
18+
| get_network_load_balancer_listener | Get a listener with a given listener name from a network load balancer |
19+
| list_network_load_balancer_backend_sets | List backend sets in a given network load balancer |
20+
| get_network_load_balancer_backend_set | Get a backend set with a given backend set name from a network load balancer |
21+
| list_network_load_balancer_backends | List backends in a given backend set and network load balancer |
22+
| get_network_load_balancer_backend | Get a backend with a given backend name from a backend set and network load balancer |
23+
24+
<span style="font-size: small;">Copyright (c) 2025, Oracle and/or its affiliates.
25+
Licensed under the Universal Permissive License v1.0 as shown at
26+
https://oss.oracle.com/licenses/upl.</span>

‎src/oci-networking-mcp-server/README.md‎

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,29 @@
1-
# OCI Networking Service MCP server
1+
# OCI Networking MCP Server
2+
3+
## Overview
4+
This server provides tools to interact with the OCI Networking resources.
5+
It includes resources and tools to help with managing network configurations.
6+
7+
## Running the server
8+
```sh
9+
uv run oracle.oci-networking-mcp-server
10+
```
11+
12+
## Tools and Resources
13+
| Tool/Resource Name | Description |
14+
| --- | --- |
15+
| list_vcns | List Virtual Cloud Networks (VCNs) in a given compartment |
16+
| get_vcn | Get a VCN with a given VCN OCID |
17+
| delete_vcn | Delete a VCN with a given VCN OCID |
18+
| create_vcn | Create a new VCN |
19+
| list_subnets | List subnets in a given compartment and VCN |
20+
| get_subnet | Get a subnet with a given subnet OCID |
21+
| create_subnet | Create a new subnet |
22+
| list_security_lists | List security lists in a given VCN and compartment |
23+
| get_security_list | Get a security list with a given security list OCID |
24+
| list_network_security_groups | List network security groups in a given compartment and VCN |
25+
| get_network_security_group | Get a network security group with a given NSG OCID |
26+
27+
<span style="font-size: small;">Copyright (c) 2025, Oracle and/or its affiliates.
28+
Licensed under the Universal Permissive License v1.0 as shown at
29+
https://oss.oracle.com/licenses/upl.</span>

‎src/oci-object-storage-mcp-server/README.md‎

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,25 @@
1-
# OCI Object Storage Service MCP server
1+
# OCI Object Storage MCP Server
22

3-
# Queries
4-
1. get namespace for my compartment: compartment_id
5-
2. use compartment comp_id for all communications
6-
3. list my buckets
7-
4. list objects in the bucket bucket_name
8-
5. list objects with prefix prefix_name in bucket bucket_name
9-
6. list versions of object object_name in bucket bucket_name
3+
## Overview
4+
This server provides tools to interact with the OCI Object Storage resources.
5+
It includes resources and tools to help with managing object storage configurations.
106

7+
## Running the server
8+
```sh
9+
uv run oracle.oci-object-storage-mcp-server
10+
```
1111

12-
----
13-
<small>
14-
Copyright (c) 2025, Oracle and/or its affiliates.
15-
16-
Licensed under the Universal Permissive License v1.0 as shown at https://oss.oracle.com/licenses/upl.
17-
</small>
12+
## Tools and Resources
13+
| Tool/Resource Name | Description |
14+
| --- | --- |
15+
| get_namespace | Get the object storage namespace for the tenancy |
16+
| list_buckets | List object storage buckets in a given compartment |
17+
| get_bucket_details | Get details for a specific object storage bucket |
18+
| list_objects | List objects in a given object storage bucket |
19+
| list_object_versions | List object versions in a given object storage bucket |
20+
| get_object | Get a specific object from an object storage bucket |
21+
| upload_object | Upload an object to an object storage bucket |
1822

23+
<span style="font-size: small;">Copyright (c) 2025, Oracle and/or its affiliates.
24+
Licensed under the Universal Permissive License v1.0 as shown at
25+
https://oss.oracle.com/licenses/upl.</span>

0 commit comments

Comments
 (0)