Skip to content

Commit b7468c2

Browse files
committed
Update roadmap and CHANGELOG
Signed-off-by: Mihai Criveti <[email protected]>
1 parent cc5f0a7 commit b7468c2

File tree

2 files changed

+157
-1
lines changed

2 files changed

+157
-1
lines changed

CHANGELOG.md

Lines changed: 153 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,159 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
66

77
---
88

9-
## [0.3.1] - 2025-01-11 - Security and Data Validation (Pydantic, UI)
9+
## [0.4.0] - 2025-07-22 - Security, Bugfixes, Resilience & Code Quality
10+
11+
### Security Notice
12+
13+
> **This is a security-focused release. Upgrading is highly recommended.**
14+
>
15+
> This release continues our security-first approach with the Admin UI and Admin API **disabled by default**. To enable these features for local development, update your `.env` file:
16+
> ```bash
17+
> # Enable the visual Admin UI (true/false)
18+
> MCPGATEWAY_UI_ENABLED=true
19+
>
20+
> # Enable the Admin API endpoints (true/false)
21+
> MCPGATEWAY_ADMIN_API_ENABLED=true
22+
> ```
23+
24+
### Overview
25+
26+
This release represents a major milestone in code quality, security, and reliability. With [52 issues resolved](https://github.com/IBM/mcp-context-forge/issues?q=is%3Aissue%20state%3Aclosed%20milestone%3A%22Release%200.4.0%22), we've achieved:
27+
- **100% security scanner compliance** (Bandit, Grype, nodejsscan)
28+
- **60% docstring coverage** with enhanced documentation
29+
- **82% pytest coverage** including end-to-end testing and security tests
30+
- **10/10 Pylint score** across the entire codebase (along existing 100% pass for ruff, pre-commit)
31+
- **Comprehensive input validation** security test suite, checking for security issues and input validation
32+
- **Smart retry mechanisms** with exponential backoff for resilient connections
33+
34+
### Added
35+
36+
* **Resilience & Reliability**:
37+
* **HTTPX Client with Smart Retry** (#456) - Automatic retry with exponential backoff and jitter for failed requests
38+
* **Docker HEALTHCHECK** (#362) - Container health monitoring for production deployments
39+
* **Enhanced Error Handling** - Replaced assert statements with proper exceptions throughout codebase
40+
41+
* **Developer Experience**:
42+
* **Test MCP Server Connectivity Tool** (#181) - Debug and validate gateway connections directly from Admin UI
43+
* **Persistent Admin UI Filter State** (#177) - Filters and preferences persist across page refreshes
44+
* **Contextual Hover-Help Tooltips** (#233) - Inline help throughout the UI for better user guidance
45+
* **mcp-cli Documentation** (#46) - Comprehensive guide for using MCP Gateway with the official CLI
46+
* **JSON-RPC Developer Guide** (#19) - Complete curl command examples for API integration
47+
48+
* **Security Enhancements**:
49+
* **Comprehensive Input Validation Test Suite** (#552) - Extensive security tests for all input scenarios
50+
* **Additional Security Scanners** (#415) - Added nodejsscan (#499) for JavaScript security analysis
51+
* **Enhanced Validation Rules** (#339, #340) - Stricter input validation across all API endpoints
52+
* **Output Escaping in UI** (#336) - Proper HTML escaping for all user-controlled content
53+
54+
* **Code Quality Tools**:
55+
* **Dead Code Detection** (#305) - Vulture and unimport integration for cleaner codebase
56+
* **Security Vulnerability Scanning** (#279) - Grype integration in CI/CD pipeline
57+
* **60% Doctest Coverage** (#249) - Executable documentation examples with automated testing
58+
59+
### Fixed
60+
61+
* **Critical Bugs**:
62+
* **STREAMABLEHTTP Transport** (#213) - Fixed critical issues preventing use of Streamable HTTP
63+
* **Authentication Handling** (#232) - Resolved "Auth to None" failures
64+
* **Gateway Authentication** (#471, #472) - Fixed auth_username and auth_password not being set correctly
65+
* **XSS Prevention** (#361) - Prompt and RPC endpoints now properly validate content
66+
* **Transport Validation** (#359) - Gateway validation now correctly rejects invalid transport types
67+
68+
* **UI/UX Improvements**:
69+
* **Dark Theme Visibility** (#366) - Fixed contrast and readability issues in dark mode
70+
* **Test Server Connectivity** (#367) - Repaired broken connectivity testing feature
71+
* **Duplicate Server Names** (#476) - UI now properly shows errors for duplicate names
72+
* **Edit Screen Population** (#354) - Fixed fields not populating when editing entities
73+
* **Annotations Editor** (#356) - Annotations are now properly editable
74+
* **Resource Data Handling** (#352) - Fixed incorrect data mapping in resources
75+
* **UI Element Spacing** (#355) - Removed large empty spaces in text editors
76+
* **Metrics Loading Warning** (#374) - Eliminated console warnings for missing elements
77+
78+
* **API & Backend**:
79+
* **Federation HTTPS Detection** (#424) - Gateway now respects X-Forwarded-Proto headers
80+
* **Version Endpoint** (#369, #382) - API now returns proper semantic version
81+
* **Test Server URL** (#396) - Fixed incorrect URL construction for test connections
82+
* **Gateway Tool Separator** (#387) - Now respects GATEWAY_TOOL_NAME_SEPARATOR configuration
83+
* **UI-Disabled Mode** (#378) - Unit tests now properly handle disabled UI scenarios
84+
85+
* **Infrastructure & CI/CD**:
86+
* **Makefile Improvements** (#371, #433) - Fixed Docker/Podman detection and venv handling
87+
* **GHCR Push Logic** (#384) - Container images no longer incorrectly pushed on PRs
88+
* **OpenAPI Documentation** (#522) - Fixed title formatting in API specification
89+
* **Test Isolation** (#495) - Fixed test_admin_tool_name_conflict affecting actual database
90+
* **Unused Config Removal** (#419) - Removed deprecated lock_file_path from configuration
91+
92+
### Changed
93+
94+
* **Code Quality Achievements**:
95+
* **60% Docstring Coverage** (#467) - Every function and class now fully documented, complementing 82% pytest coverage
96+
* **Zero Bandit Issues** (#421) - All security linting issues resolved
97+
* **10/10 Pylint Score** (#210) - Perfect code quality score maintained
98+
* **Zero Web Stack Lint Issues** (#338) - Clean JavaScript and HTML throughout
99+
100+
* **Security Improvements**:
101+
* **Enhanced Input Validation** - Stricter backend validation rules with configurable limits, with additional UI validation rules
102+
* **Removed Git Commands** (#416) - Version detection no longer uses subprocess calls
103+
* **Secure Error Handling** (#412) - Better exception handling without information leakage
104+
105+
* **Developer Workflow**:
106+
* **E2E Acceptance Test Documentation** (#399) - Comprehensive testing guide
107+
* **Security Policy Documentation** (#376) - Clear security guidelines on GitHub Pages
108+
* **Pre-commit Configuration** (#375) - yamllint now correctly ignores node_modules
109+
* **PATCH Method Support** (#508) - REST API integration now properly supports PATCH
110+
111+
### Security
112+
113+
* All security scanners now pass with zero issues: Bandit, Grype, nodejsscan
114+
* Comprehensive input validation prevents XSS, SQL injection, and other attacks
115+
* Secure defaults with UI and Admin API disabled unless explicitly enabled
116+
* Enhanced error handling prevents information disclosure
117+
* Regular security scanning integrated into CI/CD pipeline
118+
119+
### Infrastructure
120+
121+
* Docker health checks for production readiness
122+
* Improved Makefile with OS detection and better error handling
123+
* Enhanced CI/CD with security scanning and code quality gates
124+
* Better test isolation and coverage reporting
125+
126+
---
127+
128+
### 🌟 Release Contributors
129+
130+
**This release represents our commitment to enterprise-grade security and code quality. Thanks to our amazing contributors who made this security-focused release possible!**
131+
132+
#### 🏆 Top Contributors in 0.4.0
133+
- **Mihai Criveti** (@crivetimihai) - Release coordinator, security improvements, and extensive testing infrastructure
134+
- **Madhav Kandukuri** (@madhav165) - Major input validation framework, security fixes, and test coverage improvements
135+
- **Keval Mahajan** (@kevalmahajan) - HTTPX retry mechanism implementation and UI improvements
136+
- **Manav Gupta** (@manavgup) - Comprehensive doctest coverage and Playwright test suite
137+
138+
#### 🎉 New Contributors
139+
Welcome to our first-time contributors who joined us in 0.4.0:
140+
141+
- **Satya** (@TS0713) - Fixed duplicate server name handling and invalid transport type validation
142+
- **Guoqiang Ding** (@dgq8211) - Improved tool description display with proper line wrapping
143+
- **Rakhi Dutta** (@rakdutta) - Enhanced error messages for better user experience
144+
- **Nayana R Gowda** - Fixed CodeMirror layout spacing issues
145+
- **Mohan Lakshmaiah** - Contributed UI/UX improvements and test case updates
146+
- **Shoumi Mukherjee** - Fixed resource data handling in the UI
147+
- **Reeve Barreto** (@reevebarreto) - Implemented the Test MCP Server Connectivity feature
148+
- **ChrisPC-39/Sebastian** - Achieved 10/10 Pylint score and added security scanners
149+
- **Jason Frey** (@fryguy9) - Improved GitHub Actions with official IBM Cloud CLI action
150+
151+
#### 💪 Returning Contributors
152+
Thank you to our dedicated contributors who continue to strengthen MCP Gateway:
153+
154+
- **Thong Bui** - REST API enhancements including PATCH support and path parameters
155+
- **Abdul Samad** - Dark mode improvements and UI polish
156+
157+
This release represents a true community effort with contributions from developers around the world. Your dedication to security, code quality, and user experience has made MCP Gateway more robust and enterprise-ready than ever!
158+
159+
---
160+
161+
## [0.3.1] - 2025-07-11 - Security and Data Validation (Pydantic, UI)
10162
11163
### Security Improvements
12164

docs/docs/architecture/roadmap.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,10 @@
171171

172172
---
173173

174+
WE ARE HERE
175+
176+
---
177+
174178
## Release 0.5.0 - Enterprise Operability, Auth, Configuration & Observability
175179

176180
!!! danger "Release 0.5.0 - Open (0%)"

0 commit comments

Comments
 (0)