AIML-396: Preparation for v1.0.0 release#81
Merged
ChrisEdwards merged 4 commits intomainfrom Jan 16, 2026
Merged
Conversation
Remove outdated "pre-1.0 releases" note since we're now releasing v1.0.0. Add example for MAJOR version changes relevant to MCP servers (tool renames, parameter changes).
- Add "What's New" section with link to CHANGELOG.md for release history - Add "Available Tools" section documenting all 13 MCP tools organized by category (Applications, Vulnerabilities, Libraries, Protection, Coverage, SAST) with brief descriptions Helps users discover available capabilities and breaking changes.
Document all changes for the 1.0.0 release including: - Breaking changes (tool consolidation, appId requirement, field renames) - Critical bug fixes (date filtering, status filtering, keyword search) - New capabilities (JSON metadata filtering, pagination, rules parameter) - Performance improvements (31x faster app search, N+1 elimination) - Security patches for Docker image
Update CVE affected application counts to reflect current test data: - CVE-2025-31651: 72 → 70 apps - CVE-2025-41248: 22 → 21 apps - CVE-2025-22233: 79 → 77 apps
seschis
approved these changes
Jan 16, 2026
ChrisEdwards
commented
Jan 16, 2026
| | CVE-2025-41248 | High | spring-security-core | 22 | Spring Security annotation bypass | | ||
| | CVE-2025-22233 | Low | spring-context | 79 | Spring Framework disallowedFields bypass | | ||
| | CVE-2025-48989 | High | tomcat-embed-core | 72 | Apache Tomcat reset attack | | ||
| | CVE-2025-31651 | Critical | tomcat-embed-core | 70 | Apache Tomcat rewrite rule bypass | |
Collaborator
Author
There was a problem hiding this comment.
The changes in this file just update the expectations to match the data in staging. No need to review as its not production code. I manually verified the numers in the contrast ui.
ChrisEdwards
commented
Jan 16, 2026
| ### Step 2: Derive Expected Values Using Code | ||
|
|
||
| **CRITICAL: Do NOT manually count values by visually inspecting the JSON response.** | ||
| **CRITICAL--THIS IS EXTREMELY IMPORTANT!!!: Do NOT manually count values by visually inspecting the JSON response.** |
Collaborator
Author
There was a problem hiding this comment.
Same with this file
Alex-Contrast
approved these changes
Jan 16, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why This Change Exists
We're preparing to release v1.0.0 of the Contrast MCP Server. This is a major milestone release that represents months of work consolidating 27 inconsistently-named tools into 13 well-designed tools, fixing critical bugs, and adding significant new capabilities.
Before cutting the release, we need documentation that helps users understand:
Approach We Chose
This PR focuses purely on documentation updates to prepare for the release:
Outcome of this Change
Users and maintainers now have:
The Chain of Logic
Step 1: Document the Release (CHANGELOG.md)
The v1.0.0 release includes significant changes that users need to understand before upgrading:
Breaking Changes - Tool consolidation requires users to update their prompts:
app_name→appIdparameter changesessionMetadataName/Value→sessionMetadataFiltersJSONCritical Bug Fixes - These were preventing core functionality:
New Capabilities - JSON metadata filtering, pagination, performance improvements
The CHANGELOG follows Keep a Changelog format with clear sections for each type of change.
Step 2: Make Tools Discoverable (README.md)
Users need to quickly understand what the MCP server can do. Added:
Step 3: Update Release Process (RELEASING.md)
The old documentation mentioned "pre-1.0 releases use 0.0.X versioning" which is now outdated. Updated to:
Step 4: Update Manual Test Documentation
Minor update to expected CVE counts in manual test files to reflect current test data.
What Changed
CHANGELOG.mdREADME.mdREADME.mdRELEASING.mdmanual-tests/*.mdKey additions to README.md
Test Coverage
This PR contains only documentation changes - no code changes requiring tests.
Verification performed:
ls -la CHANGELOG.md- File existsmake format && make check- Passes