Skip to content

Commit 96ae7ff

Browse files
irfan-ahmedirfan-ahmed
committed
chore: Add changelogs to support publishing of MCP servers
- Added changelogs for all OCI MCP servers with information on already released versions. - Added current un-released version which will determine the next version to be published.
1 parent 78c1742 commit 96ae7ff

File tree

17 files changed

+428
-5
lines changed

17 files changed

+428
-5
lines changed

‎BEST_PRACTICES.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ This document lays out the best practices for an individual MCP server. You may
88
mcp-server-name/
99
├── LICENSE.txt # License information
1010
├── pyproject.toml # Project configuration
11+
├── CHANGELOG.md # The CHANGELOG for the server.
1112
├── README.md # Project description, setup instructions
1213
├── uv.lock # Dependency lockfile
1314
└── oracle/ # Source code directory
@@ -209,4 +210,4 @@ def list_instances(
209210
2. **Optional parameters**: Provide sensible defaults and mark as `Optional` in the type hint
210211
3. **Descriptions**: Write clear, informative descriptions for each parameter
211212
4. **Validation**: Use Field constraints like `ge`, `le`, `min_length`, `max_length`
212-
5. **Literals**: Use `Literal` for parameters with a fixed set of valid values
213+
5. **Literals**: Use `Literal` for parameters with a fixed set of valid values

‎CONTRIBUTING.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,12 @@ can be accepted.
4242
the issue number as part of your branch name, e.g. `1234-fixes`.
4343
4. Ensure that any documentation is updated with the changes that are required
4444
by your change.
45-
5. Ensure that any samples are updated if the base image has been changed.
46-
6. Submit the pull request. *Do not leave the pull request blank*. Explain exactly
45+
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.
46+
6. Ensure that any samples are updated if the base image has been changed.
47+
7. Submit the pull request. *Do not leave the pull request blank*. Explain exactly
4748
what your changes are meant to do and provide simple steps on how to validate.
4849
your changes. Ensure that you reference the issue you created as well.
49-
1. We will assign the pull request to 2-3 people for review before it is merged.
50+
8. We will assign the pull request to 2-3 people for review before it is merged.
5051

5152
## Code of conduct
5253

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

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Changelog
2+
3+
All notable changes to oracle-oci-api-mcp-server will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
The sub-sections are used to generate the next version of the project.
9+
10+
## [Unreleased]
11+
12+
### Major (breaking)
13+
14+
15+
### Minor (non-breaking)
16+
- Support Autonomous Recovery Service APIs
17+
- Fixed properly handle malformed command output
18+
19+
### Patch
20+
- Updated server.py to add more context for get_oci_command_help call
21+
- Add build, versioning and publishing infrastructure
22+
- Added support for coverage report generation
23+
24+
25+
## [1.0.2] - 2025-11-24
26+
- Updated the server.py according to the new best practices doc
27+
28+
## [1.0.1] - 2025-10-15
29+
- Fixed missing package files
30+
- README disclaimers and consistency updates
31+
- Package fixes and cleanup
32+
- Fixed server output and improved prompts
33+
- Support for a deny list of commands that should be denied execution
34+
- Update license files and dependencies
35+
- Add custom user agent header
36+
- Add copyright headers
37+
- Fixed module names for generic mcp server and improve context
38+
- Added the OCI API MCP server

‎src/oci-cloud-guard-mcp-server/CHANGELOG.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Changelog
2+
3+
All notable changes to oracle-oci-cloud-guard-mcp-server will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
The sub-sections are used to generate the next version of the project.
9+
10+
## [Unreleased]
11+
12+
### Major (breaking)
13+
- Added the OCI Cloud Guard (Problems) MCP server
14+
15+
### Minor (non-breaking)
16+
17+
18+
### Patch
19+
- Added build, versioning and publishing infrastructure
20+
- Added support for coverage report generation
21+
22+

‎src/oci-cloud-guard-mcp-server/pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "oracle.oci-cloud-guard-mcp-server"
3-
version = "1.0.0"
3+
version = "0.0.0"
44
description = "OCI Cloud Guard Service MCP server"
55
readme = "README.md"
66
requires-python = ">=3.13"

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

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Changelog
2+
3+
All notable changes to oracle-oci-compute-instance-agent-mcp-server will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
The sub-sections are used to generate the next version of the project.
9+
10+
## [Unreleased]
11+
12+
### Major (breaking)
13+
14+
15+
### Minor (non-breaking)
16+
17+
18+
### Patch
19+
- Added build, versioning, and publishing infrastructure
20+
- Added support for coverage report generation
21+
22+
23+
## [1.0.1] - 2025-10-15
24+
- README disclaimers and consistency updates
25+
- Package fixes and cleanup
26+
- Update license files and dependencies
27+
- Add custom user agent header
28+
- Add copyright headers
29+
- Added the OCI Compute instance agent MCP server
30+

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

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Changelog
2+
3+
All notable changes to oracle-oci-compute-mcp-server will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
The sub-sections are used to generate the next version of the project.
9+
10+
## [Unreleased]
11+
12+
### Major (breaking)
13+
14+
15+
### Minor (non-breaking)
16+
17+
18+
### Patch
19+
- Added build, versioning and publishing infrastructure
20+
- Added support for coverage report generation
21+
22+
23+
## [1.0.2] - 2025-10-30
24+
- Updated the code to conform to the new best practices document
25+
26+
27+
## [1.0.1] - 2025-10-15
28+
- README disclaimers and consistency updates
29+
- List instances limit and lifecycle state filter
30+
- Fix update instance
31+
- Implement launch instance
32+
- Add copyright headers
33+
- Remove utils from compute server
34+
- Strong types in the compute server
35+
- Added the OCI Compute MCP server
36+

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

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Changelog
2+
3+
All notable changes to oracle-oci-identity-mcp-server will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
The sub-sections are used to generate the next version of the project.
9+
10+
## [Unreleased]
11+
12+
### Major (breaking)
13+
14+
15+
### Minor (non-breaking)
16+
17+
18+
### Patch
19+
- Added build, versioning and publishing infrastructure
20+
- Added support for coverage report generation
21+
22+
23+
## [1.0.1] - 2025-10-15
24+
- README disclaimers and consistency updates
25+
- Package fixes and cleanup
26+
- Update license files
27+
- Update dependencies
28+
- Added custom user agent header
29+
- Added copyright headers

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

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Changelog
2+
3+
All notable changes to oracle-oci-logging-mcp-server will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
The sub-sections are used to generate the next version of the project.
9+
10+
## [Unreleased]
11+
12+
### Major (breaking)
13+
14+
15+
### Minor (non-breaking)
16+
17+
18+
### Patch
19+
- Added build, versioning and publishing infrastructure
20+
- Added support for coverage report generation
21+
22+
23+
## [1.0.1] - 2025-10-15
24+
- Added missing package files
25+
- README disclaimers and consistency updates
26+
- Logging MCP Server
27+
28+

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

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Changelog
2+
3+
All notable changes to oracle-oci-migration-mcp-server will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
The sub-sections are used to generate the next version of the project.
9+
10+
## [Unreleased]
11+
12+
### Major (breaking)
13+
14+
15+
### Minor (non-breaking)
16+
17+
18+
### Patch
19+
- Added build, versioning and publishing infrastructure
20+
- Added support for coverage report generation
21+
22+
23+
## [1.0.1] - 2025-10-15
24+
- README disclaimers and consistency updates
25+
- Package fixes and cleanup
26+
- Updated license files
27+
- Update dependencies
28+
- Added custom user agent header
29+
- Added copyright headers
30+

0 commit comments

Comments
 (0)