Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
25 changes: 19 additions & 6 deletions src/oci-api-mcp-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. |

<span style="font-size: small;">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.</span>
⚠️ **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
<https://oss.oracle.com/licenses/upl/>.
34 changes: 24 additions & 10 deletions src/oci-compute-instance-agent-mcp-server/README.md
Original file line number Diff line number Diff line change
@@ -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

<span style="font-size: small;">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.</span>
Copyright (c) 2025 Oracle and/or its affiliates.

Released under the Universal Permissive License v1.0 as shown at
<https://oss.oracle.com/licenses/upl/>.
26 changes: 20 additions & 6 deletions src/oci-compute-mcp-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand All @@ -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 |

<span style="font-size: small;">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.</span>
⚠️ **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
<https://oss.oracle.com/licenses/upl/>.

22 changes: 18 additions & 4 deletions src/oci-identity-mcp-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
Expand All @@ -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. |

<span style="font-size: small;">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.</span>
⚠️ **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
<https://oss.oracle.com/licenses/upl/>.

25 changes: 19 additions & 6 deletions src/oci-logging-mcp-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |

<span style="font-size: small;">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.</span>
⚠️ **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
<https://oss.oracle.com/licenses/upl/>.
32 changes: 23 additions & 9 deletions src/oci-migration-mcp-server/README.md
Original file line number Diff line number Diff line change
@@ -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

<span style="font-size: small;">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.</span>
Copyright (c) 2025 Oracle and/or its affiliates.

Released under the Universal Permissive License v1.0 as shown at
<https://oss.oracle.com/licenses/upl/>.
32 changes: 23 additions & 9 deletions src/oci-monitoring-mcp-server/README.md
Original file line number Diff line number Diff line change
@@ -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

<span style="font-size: small;">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.</span>
Copyright (c) 2025 Oracle and/or its affiliates.

Released under the Universal Permissive License v1.0 as shown at
<https://oss.oracle.com/licenses/upl/>.
25 changes: 19 additions & 6 deletions src/oci-network-load-balancer-mcp-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand All @@ -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 |

<span style="font-size: small;">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.</span>
⚠️ **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
<https://oss.oracle.com/licenses/upl/>.
25 changes: 19 additions & 6 deletions src/oci-networking-mcp-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand All @@ -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 |

<span style="font-size: small;">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.</span>
⚠️ **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
<https://oss.oracle.com/licenses/upl/>.
Loading