Skip to content

Commit e7bcaf7

Browse files
gebhardtrgebhardtr
authored
chore: README disclaimers and consistency updates (#27)
Signed-off-by: Richard Gebhardt <[email protected]>
1 parent 22b1ad0 commit e7bcaf7

File tree

13 files changed

+266
-90
lines changed

13 files changed

+266
-90
lines changed

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

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,32 @@
22

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

77
## Running the server
88
```sh
99
uv run oracle.oci-api-mcp-server
1010
```
11-
## Tools and Resources
12-
| Tool/Resource Name | Description |
11+
## Tools
12+
| Tool Name | Description |
1313
| --- | --- |
1414
| 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. |
1515
| 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. |
1616
| get_oci_commands (Resource) | Returns helpful information on various OCI services and related commands. |
1717

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>
18+
⚠️ **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.
19+
20+
## Third-Party APIs
21+
22+
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.
23+
24+
## Disclaimer
25+
26+
Users are responsible for their local environment and credential safety. Different language model selections may yield different results and performance.
27+
28+
## License
29+
30+
Copyright (c) 2025 Oracle and/or its affiliates.
31+
32+
Released under the Universal Permissive License v1.0 as shown at
33+
<https://oss.oracle.com/licenses/upl/>.

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

Lines changed: 24 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,35 @@
11
# OCI Compute Instance Agent MCP Server
22

33
## 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.
4+
5+
This server provides tools for interacting with Oracle Cloud Infrastructure (OCI) Compute Instance Agent service.
66

77
## Running the server
88
```sh
99
uv run oracle.oci-compute-instance-agent-mcp-server
1010
```
1111

12-
## Tools and Resources
13-
| Tool/Resource Name | Description |
12+
## Tools
13+
| Tool Name | Description |
1414
| --- | --- |
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 |
15+
| list_instance_agent_commands | List instance agent commands |
16+
| get_instance_agent_command | Get instance agent command by ID |
17+
| create_instance_agent_command | Create a new instance agent command |
18+
| list_instance_agent_command_executions | List command executions for an instance agent command |
19+
20+
⚠️ **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.
21+
22+
## Third-Party APIs
23+
24+
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.
25+
26+
## Disclaimer
27+
28+
Users are responsible for their local environment and credential safety. Different language model selections may yield different results and performance.
29+
30+
## License
1831

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>
32+
Copyright (c) 2025 Oracle and/or its affiliates.
33+
34+
Released under the Universal Permissive License v1.0 as shown at
35+
<https://oss.oracle.com/licenses/upl/>.

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

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

33
## Overview
44
This server provides tools to interact with the OCI Compute resources.
5-
It includes resources and tools to help with managing compute instances.
5+
It includes tools to help with managing compute instances.
66

77
## Running the server
88
```sh
99
uv run oracle.oci-compute-mcp-server
1010
```
1111

12-
## Tools and Resources
13-
| Tool/Resource Name | Description |
12+
## Tools
13+
| Tool Name | Description |
1414
| --- | --- |
1515
| list_instances | List Instances in a given compartment |
1616
| get_instance | Get Instance with a given instance OCID |
@@ -21,6 +21,20 @@ uv run oracle.oci-compute-mcp-server
2121
| get_image | Get Image with a given image OCID |
2222
| instance_action | Perform actions on a given instance |
2323

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>
24+
⚠️ **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.
25+
26+
## Third-Party APIs
27+
28+
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.
29+
30+
## Disclaimer
31+
32+
Users are responsible for their local environment and credential safety. Different language model selections may yield different results and performance.
33+
34+
## License
35+
36+
Copyright (c) 2025 Oracle and/or its affiliates.
37+
38+
Released under the Universal Permissive License v1.0 as shown at
39+
<https://oss.oracle.com/licenses/upl/>.
40+

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

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This server provides tools to interact with the OCI Identity service.
88
uv run oracle.oci-identity-mcp-server
99
```
1010

11-
## Tools and Resources
11+
## Tools
1212
| Tool Name | Description |
1313
| --- | --- |
1414
| list_compartments | List compartments in a given tenancy. |
@@ -18,6 +18,20 @@ uv run oracle.oci-identity-mcp-server
1818
| create_auth_token | Create an authentication token for a user. |
1919
| get_current_user | Get current user information. |
2020

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>
21+
⚠️ **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.
22+
23+
## Third-Party APIs
24+
25+
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.
26+
27+
## Disclaimer
28+
29+
Users are responsible for their local environment and credential safety. Different language model selections may yield different results and performance.
30+
31+
## License
32+
33+
Copyright (c) 2025 Oracle and/or its affiliates.
34+
35+
Released under the Universal Permissive License v1.0 as shown at
36+
<https://oss.oracle.com/licenses/upl/>.
37+

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

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,33 @@
22

33
## Overview
44
This server provides tools to interact with the OCI Logging resources.
5-
It includes resources and tools to help with managing logging configurations.
5+
It includes tools to help with managing logging configurations.
66

77
## Running the server
88
```sh
99
uv run oracle.oci-logging-mcp-server
1010
```
1111

12-
## Tools and Resources
13-
| Tool/Resource Name | Description |
12+
## Tools
13+
| Tool Name | Description |
1414
| --- | --- |
1515
| list_log_groups | List log groups in a given compartment |
1616
| list_logs | List logs in a given log group |
1717
| get_log | Get a log with a given log OCID |
1818

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>
19+
⚠️ **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.
20+
21+
## Third-Party APIs
22+
23+
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.
24+
25+
## Disclaimer
26+
27+
Users are responsible for their local environment and credential safety. Different language model selections may yield different results and performance.
28+
29+
## License
30+
31+
Copyright (c) 2025 Oracle and/or its affiliates.
32+
33+
Released under the Universal Permissive License v1.0 as shown at
34+
<https://oss.oracle.com/licenses/upl/>.

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

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,34 @@
11
# OCI Migration MCP Server
22

33
## 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.
4+
5+
This server provides tools for interacting with Oracle Cloud Infrastructure (OCI) Migration service.
66

77
## Running the server
88
```sh
99
uv run oracle.oci-migration-mcp-server
1010
```
1111

12-
## Tools and Resources
13-
| Tool/Resource Name | Description |
12+
## Tools
13+
| Tool Name | Description |
1414
| --- | --- |
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 |
15+
| list_migrations | List migrations in the tenancy |
16+
| get_migration | Get migration by ID |
17+
18+
19+
⚠️ **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.
20+
21+
## Third-Party APIs
22+
23+
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.
24+
25+
## Disclaimer
26+
27+
Users are responsible for their local environment and credential safety. Different language model selections may yield different results and performance.
28+
29+
## License
1730

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>
31+
Copyright (c) 2025 Oracle and/or its affiliates.
32+
33+
Released under the Universal Permissive License v1.0 as shown at
34+
<https://oss.oracle.com/licenses/upl/>.

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

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,34 @@
11
# OCI Monitoring MCP Server
22

33
## Overview
4-
This server provides tools to interact with the OCI Monitoring resources.
5-
It includes resources and tools to help with monitoring configurations.
4+
5+
This server provides tools for interacting with Oracle Cloud Infrastructure (OCI) Monitoring service.
66

77
## Running the server
88
```sh
99
uv run oracle.oci-monitoring-mcp-server
1010
```
1111

12-
## Tools and Resources
13-
| Tool/Resource Name | Description |
12+
## Tools
13+
| Tool Name | Description |
1414
| --- | --- |
15-
| get_compute_metrics | Retrieve compute metrics for a given compartment and time range |
16-
| list_alarms | List alarms in a given compartment |
15+
| list_metrics | List metrics in the tenancy |
16+
| get_metric | Get metric by name |
17+
18+
19+
⚠️ **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.
20+
21+
## Third-Party APIs
22+
23+
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.
24+
25+
## Disclaimer
26+
27+
Users are responsible for their local environment and credential safety. Different language model selections may yield different results and performance.
28+
29+
## License
1730

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>
31+
Copyright (c) 2025 Oracle and/or its affiliates.
32+
33+
Released under the Universal Permissive License v1.0 as shown at
34+
<https://oss.oracle.com/licenses/upl/>.

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

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

33
## Overview
44
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.
5+
It includes tools to help with managing network load balancers.
66

77
## Running the server
88
```sh
99
uv run oracle.oci-network-load-balancer-mcp-server
1010
```
1111

12-
## Tools and Resources
13-
| Tool/Resource Name | Description |
12+
## Tools
13+
| Tool Name | Description |
1414
| --- | --- |
1515
| list_network_load_balancers | List network load balancers in a given compartment |
1616
| get_network_load_balancer | Get network load balancer details |
@@ -21,6 +21,19 @@ uv run oracle.oci-network-load-balancer-mcp-server
2121
| list_network_load_balancer_backends | List backends in a given backend set and network load balancer |
2222
| get_network_load_balancer_backend | Get a backend with a given backend name from a backend set and network load balancer |
2323

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>
24+
⚠️ **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.
25+
26+
## Third-Party APIs
27+
28+
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.
29+
30+
## Disclaimer
31+
32+
Users are responsible for their local environment and credential safety. Different language model selections may yield different results and performance.
33+
34+
## License
35+
36+
Copyright (c) 2025 Oracle and/or its affiliates.
37+
38+
Released under the Universal Permissive License v1.0 as shown at
39+
<https://oss.oracle.com/licenses/upl/>.

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

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

33
## Overview
44
This server provides tools to interact with the OCI Networking resources.
5-
It includes resources and tools to help with managing network configurations.
5+
It includes tools to help with managing network configurations.
66

77
## Running the server
88
```sh
99
uv run oracle.oci-networking-mcp-server
1010
```
1111

12-
## Tools and Resources
13-
| Tool/Resource Name | Description |
12+
## Tools
13+
| Tool Name | Description |
1414
| --- | --- |
1515
| list_vcns | List Virtual Cloud Networks (VCNs) in a given compartment |
1616
| get_vcn | Get a VCN with a given VCN OCID |
@@ -24,6 +24,19 @@ uv run oracle.oci-networking-mcp-server
2424
| list_network_security_groups | List network security groups in a given compartment and VCN |
2525
| get_network_security_group | Get a network security group with a given NSG OCID |
2626

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>
27+
⚠️ **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.
28+
29+
## Third-Party APIs
30+
31+
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.
32+
33+
## Disclaimer
34+
35+
Users are responsible for their local environment and credential safety. Different language model selections may yield different results and performance.
36+
37+
## License
38+
39+
Copyright (c) 2025 Oracle and/or its affiliates.
40+
41+
Released under the Universal Permissive License v1.0 as shown at
42+
<https://oss.oracle.com/licenses/upl/>.

0 commit comments

Comments
 (0)