diff --git a/BEST_PRACTICES.md b/BEST_PRACTICES.md index 2a3fb51..1be397c 100644 --- a/BEST_PRACTICES.md +++ b/BEST_PRACTICES.md @@ -8,6 +8,7 @@ This document lays out the best practices for an individual MCP server. You may mcp-server-name/ ├── LICENSE.txt # License information ├── pyproject.toml # Project configuration +├── CHANGELOG.md # The CHANGELOG for the server. ├── README.md # Project description, setup instructions ├── uv.lock # Dependency lockfile └── oracle/ # Source code directory @@ -209,4 +210,4 @@ def list_instances( 2. **Optional parameters**: Provide sensible defaults and mark as `Optional` in the type hint 3. **Descriptions**: Write clear, informative descriptions for each parameter 4. **Validation**: Use Field constraints like `ge`, `le`, `min_length`, `max_length` -5. **Literals**: Use `Literal` for parameters with a fixed set of valid values \ No newline at end of file +5. **Literals**: Use `Literal` for parameters with a fixed set of valid values diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b0b128e..5be7f94 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -42,11 +42,12 @@ can be accepted. the issue number as part of your branch name, e.g. `1234-fixes`. 4. Ensure that any documentation is updated with the changes that are required by your change. -5. Ensure that any samples are updated if the base image has been changed. -6. Submit the pull request. *Do not leave the pull request blank*. Explain exactly +5. Ensure that any change to any of the MCP servers has a corresponding update in the CHANGELOG.md for that respective MCP server. Changes to MCP servers without corresponding changes in the CHANGELOG.MD will be rejected. +6. Ensure that any samples are updated if the base image has been changed. +7. Submit the pull request. *Do not leave the pull request blank*. Explain exactly what your changes are meant to do and provide simple steps on how to validate. your changes. Ensure that you reference the issue you created as well. -1. We will assign the pull request to 2-3 people for review before it is merged. +8. We will assign the pull request to 2-3 people for review before it is merged. ## Code of conduct diff --git a/src/oci-api-mcp-server/CHANGELOG.md b/src/oci-api-mcp-server/CHANGELOG.md new file mode 100644 index 0000000..32ec55c --- /dev/null +++ b/src/oci-api-mcp-server/CHANGELOG.md @@ -0,0 +1,38 @@ +# Changelog + +All notable changes to oracle-oci-api-mcp-server will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +The sub-sections are used to generate the next version of the project. + +## [Unreleased] + +### Major (breaking) + + +### Minor (non-breaking) +- Support Autonomous Recovery Service APIs +- Fixed properly handle malformed command output + +### Patch +- Updated server.py to add more context for get_oci_command_help call +- Add build, versioning and publishing infrastructure +- Added support for coverage report generation + + +## [1.0.2] - 2025-11-24 +- Updated the server.py according to the new best practices doc + +## [1.0.1] - 2025-10-15 +- Fixed missing package files +- README disclaimers and consistency updates +- Package fixes and cleanup +- Fixed server output and improved prompts +- Support for a deny list of commands that should be denied execution +- Update license files and dependencies +- Add custom user agent header +- Add copyright headers +- Fixed module names for generic mcp server and improve context +- Added the OCI API MCP server diff --git a/src/oci-cloud-guard-mcp-server/CHANGELOG.md b/src/oci-cloud-guard-mcp-server/CHANGELOG.md new file mode 100644 index 0000000..2ff2d83 --- /dev/null +++ b/src/oci-cloud-guard-mcp-server/CHANGELOG.md @@ -0,0 +1,22 @@ +# Changelog + +All notable changes to oracle-oci-cloud-guard-mcp-server will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +The sub-sections are used to generate the next version of the project. + +## [Unreleased] + +### Major (breaking) +- Added the OCI Cloud Guard (Problems) MCP server + +### Minor (non-breaking) + + +### Patch +- Added build, versioning and publishing infrastructure +- Added support for coverage report generation + + diff --git a/src/oci-cloud-guard-mcp-server/pyproject.toml b/src/oci-cloud-guard-mcp-server/pyproject.toml index 8ddceb1..2e65fea 100644 --- a/src/oci-cloud-guard-mcp-server/pyproject.toml +++ b/src/oci-cloud-guard-mcp-server/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "oracle.oci-cloud-guard-mcp-server" -version = "1.0.0" +version = "0.0.0" description = "OCI Cloud Guard Service MCP server" readme = "README.md" requires-python = ">=3.13" diff --git a/src/oci-compute-instance-agent-mcp-server/CHANGELOG.md b/src/oci-compute-instance-agent-mcp-server/CHANGELOG.md new file mode 100644 index 0000000..af4d0c5 --- /dev/null +++ b/src/oci-compute-instance-agent-mcp-server/CHANGELOG.md @@ -0,0 +1,30 @@ +# Changelog + +All notable changes to oracle-oci-compute-instance-agent-mcp-server will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +The sub-sections are used to generate the next version of the project. + +## [Unreleased] + +### Major (breaking) + + +### Minor (non-breaking) + + +### Patch +- Added build, versioning, and publishing infrastructure +- Added support for coverage report generation + + +## [1.0.1] - 2025-10-15 +- README disclaimers and consistency updates +- Package fixes and cleanup +- Update license files and dependencies +- Add custom user agent header +- Add copyright headers +- Added the OCI Compute instance agent MCP server + diff --git a/src/oci-compute-mcp-server/CHANGELOG.md b/src/oci-compute-mcp-server/CHANGELOG.md new file mode 100644 index 0000000..097338a --- /dev/null +++ b/src/oci-compute-mcp-server/CHANGELOG.md @@ -0,0 +1,36 @@ +# Changelog + +All notable changes to oracle-oci-compute-mcp-server will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +The sub-sections are used to generate the next version of the project. + +## [Unreleased] + +### Major (breaking) + + +### Minor (non-breaking) + + +### Patch +- Added build, versioning and publishing infrastructure +- Added support for coverage report generation + + +## [1.0.2] - 2025-10-30 +- Updated the code to conform to the new best practices document + + +## [1.0.1] - 2025-10-15 +- README disclaimers and consistency updates +- List instances limit and lifecycle state filter +- Fix update instance +- Implement launch instance +- Add copyright headers +- Remove utils from compute server +- Strong types in the compute server +- Added the OCI Compute MCP server + diff --git a/src/oci-identity-mcp-server/CHANGELOG.md b/src/oci-identity-mcp-server/CHANGELOG.md new file mode 100644 index 0000000..7e38e30 --- /dev/null +++ b/src/oci-identity-mcp-server/CHANGELOG.md @@ -0,0 +1,29 @@ +# Changelog + +All notable changes to oracle-oci-identity-mcp-server will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +The sub-sections are used to generate the next version of the project. + +## [Unreleased] + +### Major (breaking) + + +### Minor (non-breaking) + + +### Patch +- Added build, versioning and publishing infrastructure +- Added support for coverage report generation + + +## [1.0.1] - 2025-10-15 +- README disclaimers and consistency updates +- Package fixes and cleanup +- Update license files +- Update dependencies +- Added custom user agent header +- Added copyright headers diff --git a/src/oci-logging-mcp-server/CHANGELOG.md b/src/oci-logging-mcp-server/CHANGELOG.md new file mode 100644 index 0000000..a01ffe7 --- /dev/null +++ b/src/oci-logging-mcp-server/CHANGELOG.md @@ -0,0 +1,28 @@ +# Changelog + +All notable changes to oracle-oci-logging-mcp-server will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +The sub-sections are used to generate the next version of the project. + +## [Unreleased] + +### Major (breaking) + + +### Minor (non-breaking) + + +### Patch +- Added build, versioning and publishing infrastructure +- Added support for coverage report generation + + +## [1.0.1] - 2025-10-15 +- Added missing package files +- README disclaimers and consistency updates +- Logging MCP Server + + diff --git a/src/oci-migration-mcp-server/CHANGELOG.md b/src/oci-migration-mcp-server/CHANGELOG.md new file mode 100644 index 0000000..f059650 --- /dev/null +++ b/src/oci-migration-mcp-server/CHANGELOG.md @@ -0,0 +1,30 @@ +# Changelog + +All notable changes to oracle-oci-migration-mcp-server will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +The sub-sections are used to generate the next version of the project. + +## [Unreleased] + +### Major (breaking) + + +### Minor (non-breaking) + + +### Patch +- Added build, versioning and publishing infrastructure +- Added support for coverage report generation + + +## [1.0.1] - 2025-10-15 +- README disclaimers and consistency updates +- Package fixes and cleanup +- Updated license files +- Update dependencies +- Added custom user agent header +- Added copyright headers + diff --git a/src/oci-monitoring-mcp-server/CHANGELOG.md b/src/oci-monitoring-mcp-server/CHANGELOG.md new file mode 100644 index 0000000..2cc5a0a --- /dev/null +++ b/src/oci-monitoring-mcp-server/CHANGELOG.md @@ -0,0 +1,30 @@ +# Changelog + +All notable changes to oracle-oci-monitoring-mcp-server will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +The sub-sections are used to generate the next version of the project. + +## [Unreleased] + +### Major (breaking) + + +### Minor (non-breaking) + + +### Patch +- Added build, versioning and publishing infrastructure +- Added support for coverage report generation + + +## [1.0.1] - 2025-10-15 +- README disclaimers and consistency updates +- Package fixes and cleanup + +## [1.0.0] - 2025-10-13 +- Usage MCP server for cost analysis +- Update license files and dependencies +- Added copyright headers diff --git a/src/oci-network-load-balancer-mcp-server/CHANGELOG.md b/src/oci-network-load-balancer-mcp-server/CHANGELOG.md new file mode 100644 index 0000000..677f913 --- /dev/null +++ b/src/oci-network-load-balancer-mcp-server/CHANGELOG.md @@ -0,0 +1,33 @@ +# Changelog + +All notable changes to oracle-oci-network-load-balancer-mcp-server will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +The sub-sections are used to generate the next version of the project. + +## [Unreleased] + +### Major (breaking) + + +### Minor (non-breaking) + + +### Patch +- Add build, versioning and publishing infrastructure +- Added support for coverage report generation + + +## [1.0.1] - 2025-10-15 +- README disclaimers and consistency updates +- Update license files and dependencies +- Add custom user agent header +- Add copyright headers +- Lock down subprocess a bit more and fix tests +- Add network security tools +- Add NLB tests +- Implement basic NLB server + + diff --git a/src/oci-networking-mcp-server/CHANGELOG.md b/src/oci-networking-mcp-server/CHANGELOG.md new file mode 100644 index 0000000..7d181ec --- /dev/null +++ b/src/oci-networking-mcp-server/CHANGELOG.md @@ -0,0 +1,30 @@ +# Changelog + +All notable changes to oracle-oci-networking-mcp-server will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +The sub-sections are used to generate the next version of the project. + +## [Unreleased] + +### Major (breaking) + + +### Minor (non-breaking) + + +### Patch +- Added build, versioning and publishing infrastructure +- Added support for coverage report generation + + +## [1.0.1] - 2025-10-15 +- README disclaimers and consistency updates +- Package fixes and cleanup +- Update license files and dependencies +- Finish unit tests for networking mcp server +- Add custom user agent header +- Add network security tools and unit tests + diff --git a/src/oci-object-storage-mcp-server/CHANGELOG.md b/src/oci-object-storage-mcp-server/CHANGELOG.md new file mode 100644 index 0000000..37589e6 --- /dev/null +++ b/src/oci-object-storage-mcp-server/CHANGELOG.md @@ -0,0 +1,28 @@ +# Changelog + +All notable changes to oracle-oci-object-storage-mcp-server will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +The sub-sections are used to generate the next version of the project. + +## [Unreleased] + +### Major (breaking) + + +### Minor (non-breaking) + + +### Patch +- Add build, versioning and publishing infrastructure +- Added support for coverage report generation + + +## [1.0.1] - 2025-10-15 +- README disclaimers and consistency updates +- Package fixes and cleanup +- Added OCI Object Storage Service MCP Server + + diff --git a/src/oci-registry-mcp-server/CHANGELOG.md b/src/oci-registry-mcp-server/CHANGELOG.md new file mode 100644 index 0000000..509ab58 --- /dev/null +++ b/src/oci-registry-mcp-server/CHANGELOG.md @@ -0,0 +1,29 @@ +# Changelog + +All notable changes to oracle-oci-registry-mcp-server will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +The sub-sections are used to generate the next version of the project. + +## [Unreleased] + +### Major (breaking) + + +### Minor (non-breaking) + + +### Patch +- Add build, versioning and publishing infrastructure +- Added support for coverage report generation + + +## [1.0.1] - 2025-10-15 +- README disclaimers and consistency updates +- Package fixes and cleanup +- Update license files and dependencies +- Add custom user agent header +- add copyright headers +- Added the OCI Registry MCP Server diff --git a/src/oci-resource-search-mcp-server/CHANGELOG.md b/src/oci-resource-search-mcp-server/CHANGELOG.md new file mode 100644 index 0000000..acf7dfd --- /dev/null +++ b/src/oci-resource-search-mcp-server/CHANGELOG.md @@ -0,0 +1,29 @@ +# Changelog + +All notable changes to oracle-oci-resource-search-mcp-server will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +The sub-sections are used to generate the next version of the project. + +## [Unreleased] + +### Major (breaking) + + +### Minor (non-breaking) + + +### Patch +- Add build, versioning and publishing infrastructure +- Added support for coverage report generation + + +## [1.0.1] - 2025-10-15 +- README disclaimers and consistency updates +- Package fixes and cleanup +- Update license files and dependencies +- Add custom user agent header +- Add tests +- Add the OCI Resource Search MCP server diff --git a/src/oci-usage-mcp-server/CHANGELOG.md b/src/oci-usage-mcp-server/CHANGELOG.md new file mode 100644 index 0000000..99fb2c2 --- /dev/null +++ b/src/oci-usage-mcp-server/CHANGELOG.md @@ -0,0 +1,29 @@ +# Changelog + +All notable changes to oracle-oci-usage-mcp-server will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +The sub-sections are used to generate the next version of the project. + +## [Unreleased] + +### Major (breaking) + + +### Minor (non-breaking) + + +### Patch +- Add build, versioning and publishing infrastructure +- Added support for coverage report generation + + +## [1.0.1] - 2025-10-15 +- README disclaimers and consistency updates +- Package fixes and cleanup +- Added the Usage MCP server for cost analysis + + +