Skip to content

Commit c2fc4e9

Browse files
authored
Merge pull request #170 from IBM/update-docs-for-0-2-0
Update docs for 0 2 0
2 parents 0d6af89 + 555e82e commit c2fc4e9

File tree

5 files changed

+150
-6
lines changed

5 files changed

+150
-6
lines changed

.github/tools/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
changelog_info.txt
Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
#!/usr/bin/env bash
2+
#
3+
# generate-changelog-info.sh
4+
# Author: Mihai Criveti
5+
#
6+
# Dump to one file:
7+
# 1. Full commit logs since a tag
8+
# 2. A chronologically-sorted list of issues closed since that tag
9+
# 3. Full JSON-formatted details for every one of those issues
10+
#
11+
# Dependencies: git, GitHub CLI (`gh`), jq
12+
# Usage: ./generate-changelog-info.sh [TAG] [OUTPUT_FILE]
13+
# TAG defaults to v0.1.1
14+
# OUTPUT_FILE defaults to changelog_info.txt
15+
#
16+
set -euo pipefail
17+
18+
TAG=${1:-v0.1.1}
19+
OUT=${2:-changelog_info.txt}
20+
21+
###############################################################################
22+
# 1. Commit log
23+
###############################################################################
24+
{
25+
echo "#############################"
26+
echo "## COMMITS since ${TAG}"
27+
echo "#############################"
28+
} >"$OUT"
29+
30+
git log "${TAG}"..HEAD --reverse --no-merges \
31+
--pretty=format:'%H%nAuthor: %an <%ae>%nDate: %ad%n%n%s%n%n%b%n----' \
32+
--date=short >>"$OUT"
33+
34+
###############################################################################
35+
# 2. Closed-issue list (oldest → newest)
36+
###############################################################################
37+
CUTOFF=$(git log -1 --format=%cI "$TAG") # ISO time of the tag
38+
39+
echo -e "\n#############################" >>"$OUT"
40+
echo "## ISSUES closed since ${TAG}" >>"$OUT"
41+
echo "#############################" >>"$OUT"
42+
43+
ISSUES_JSON=$(gh issue list --state closed \
44+
--search "closed:>=$CUTOFF" \
45+
--limit 1000 \
46+
--json number,title,closedAt,url)
47+
48+
echo "$ISSUES_JSON" | jq -r '
49+
sort_by(.closedAt)[]
50+
| "#\(.number) – \(.title) (closed: \(.closedAt))"
51+
' >>"$OUT"
52+
53+
###############################################################################
54+
# 3. Full issue details
55+
###############################################################################
56+
echo -e "\n#############################" >>"$OUT"
57+
echo "## ISSUE DETAILS" >>"$OUT"
58+
echo "#############################" >>"$OUT"
59+
60+
# Extract the numbers, then loop for detailed views
61+
echo "$ISSUES_JSON" | jq -r '.[].number' | while read -r NUM; do
62+
echo -e "\n---- ISSUE #$NUM ----" >>"$OUT"
63+
gh issue view "$NUM" --json number,title,author,labels,assignees,closedAt,createdAt,url,body \
64+
| jq -r '
65+
"Number: \(.number)",
66+
"Title: \(.title)",
67+
"URL: \(.url)",
68+
"Author: \(.author.login // "unknown")",
69+
"Labels: \(.labels | map(.name) | join(", "))",
70+
"Assignees: \(.assignees | map(.login) | join(", "))",
71+
"Created: \(.createdAt)",
72+
"Closed: \(.closedAt)",
73+
"",
74+
"Body:\n" + (.body // "*No description*")
75+
' >>"$OUT"
76+
done
77+
78+
echo -e "\nAll done! Results written to: $OUT"

CHANGELOG.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,71 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
88

99
## [0.2.0] - 2025-06-24
1010

11+
### Added
12+
13+
* **Streamable HTTP transport** – full first-class support for MCP's new default transport (deprecated SSE):
14+
15+
* gateway accepts Streamable HTTP client connections (stateful & stateless). SSE support retained.
16+
* UI & API allow registering Streamable HTTP MCP servers with health checks, auth & time-outs
17+
* UI now shows a *transport* column for each gateway/tool;
18+
* **Authentication & stateful sessions** for Streamable HTTP clients/servers (Basic/Bearer headers, session persistence).
19+
* **Gateway hardening** – connection-level time-outs and smarter health-check retries to avoid UI hangs
20+
* **Fast Go MCP server example** – high-performance reference server for benchmarking/demos.
21+
* **Exportable connection strings** – one-click download & `/servers/{id}/connect` API that generates ready-made configs for LangChain, Claude Desktop, etc. (closed #154).
22+
* **Infrastructure as Code** – initial Terraform & Ansible scripts for cloud installs.
23+
* **Developer tooling & UX**
24+
25+
* `tox`, GH Actions *pytest + coverage* workflow
26+
* pre-commit linters (ruff, flake8, yamllint) & security scans
27+
* dark-mode theme and compact version-info panel in Admin UI
28+
* developer onboarding checklist in docs.
29+
* **Deployment assets** – Helm charts now accept external secrets/Redis; Fly.io guide; Docker-compose local-image switch; Helm deployment walkthrough.
30+
31+
### Changed
32+
33+
* **Minimum supported Python is now 3.11**; CI upgraded to Ubuntu 24.04 / Python 3.12.
34+
* Added detailed **context-merging algorithm** notes to docs.
35+
* Refreshed Helm charts, Makefile targets, JWT helper CLI and SBOM generation; tightened typing & linting.
36+
* 333 unit-tests now pass; major refactors in federation, tool, resource & gateway services improve reliability.
37+
38+
### Fixed
39+
40+
* SBOM generation failure in `make docs` (#132) and Makefile `images` target (#131).
41+
* GitHub Remote MCP server addition flow (#152).
42+
* REST path-parameter & payload substitution issues (#100).
43+
* Numerous flaky tests, missing dependencies and mypy/flake8 violations across the code-base .
44+
45+
### Security
46+
47+
* Dependency bumps and security-policy updates; CVE scans added to pre-commit & CI (commit ed972a8).
48+
49+
### 🙌 New contributors in 0.2.0
50+
51+
Thanks to the new **first-time contributors** who jumped in between 0.1.1 → 0.2.0:
52+
53+
| Contributor | First delivered in 0.2.0 |
54+
| ------------------------ | --------------------------------------------------------------------------------- |
55+
| **Abdul Samad** | Dark-mode styling across the Admin UI and a more compact version-info panel |
56+
| **Arun Babu Neelicattu** | Bumped the minimum supported Python to 3.11 in pyproject.toml |
57+
| **Manoj Jahgirdar** | Polished the Docs home page / index |
58+
| **Shoumi Mukherjee** | General documentation clean-ups and quick-start clarifications |
59+
| **Thong Bui** | REST adapter: path-parameter (`{id}`) support, `PATCH` handling and 204 responses |
60+
61+
Welcome aboard—your PRs made 0.2.0 measurably better! 🎉
62+
63+
---
64+
65+
### 🙏 Returning contributors who went the extra mile in 0.2.0
66+
67+
| Contributor | Highlights this release |
68+
| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
69+
| **Mihai Criveti** | Release management & 0.2.0 version bump, Helm-chart refactor + deployment guide, full CI revamp (pytest + coverage, pre-commit linters, tox), **333 green unit tests**, security updates, build updates, fully automated deployment to Code Engine, improved helm stack, doc & GIF refresh |
70+
| **Keval Mahajan** | Implemented **Streamable HTTP** transport (client + server) with auth & stateful sessions, transport column in UI, gateway time-outs, extensive test fixes and linting |
71+
| **Madhav Kandukuri** |• Wrote **ADRs for tool-federation & dropdown UX** <br>• Polished the new **dark-mode** theme<br>• Authored **Issue #154** that specified the connection-string export feature<br>• Plus multiple stability fixes (async DB, gateway add/del, UV sync, Basic-Auth headers) |
72+
| **Manav Gupta** | Fixed SBOM generation & license verification, repaired Makefile image/doc targets, improved Docker quick-start and Fly.io deployment docs |
73+
74+
*Huge thanks for keeping the momentum going! 🚀*
75+
1176

1277
## [0.1.1] - 2025‑06-14
1378

charts/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# MCP Gateway Stack – Helm Chart
22

3-
Deploy the full **MCP Gateway Stack**MCP Context Forge gateway, PostgreSQL, Redis, and optional PgAdmin & Redis‑Commander UIson any Kubernetes distribution with a single Helm release. The chart lives in [`charts/mcp-stack`](https://github.com/IBM/mcp-context-forge/tree/main/charts/mcp-stack).
3+
Deploy the full **MCP Gateway Stack**-MCP Context Forge gateway, PostgreSQL, Redis, and optional PgAdmin & Redis‑Commander UIs-on any Kubernetes distribution with a single Helm release. The chart lives in [`charts/mcp-stack`](https://github.com/IBM/mcp-context-forge/tree/main/charts/mcp-stack).
44

55
---
66

@@ -128,7 +128,7 @@ Below is a minimal example. Copy the default file and adjust for your environmen
128128
mcpContextForge:
129129
image:
130130
repository: ghcr.io/ibm/mcp-context-forge
131-
tag: v1.0.0
131+
tag: 0.2.0
132132
ingress:
133133
enabled: true
134134
host: gateway.local # replace with real DNS
@@ -201,14 +201,14 @@ kubectl delete namespace mcp
201201
helm lint .
202202
helm package . -d dist/
203203

204-
# Push the package to GitHub Container Registry
205-
helm push dist/mcp-stack-*.tgz oci://ghcr.io/<your-org>/charts
204+
# Push the package to GitHub Container Registry (only for mcp-context-forge release managers!)
205+
helm push dist/mcp-stack-*.tgz oci://ghcr.io/ibm/mcp-context-forge
206206
```
207207

208208
Use the OCI URL below in Argo CD or Flux:
209209

210210
```
211-
oci://ghcr.io/<your-org>/charts/mcp-stack
211+
oci://ghcr.io/ibm/mcp-context-forge
212212
```
213213

214214
---
@@ -260,4 +260,4 @@ For every setting see the [full annotated `values.yaml`](https://github.com/IBM/
260260
1. Fork the repo and create a feature branch.
261261
2. Update templates or `values.yaml`.
262262
3. Test with `helm lint` and `helm template`.
263-
4. Open a pull requestthank you!
263+
4. Open a pull request-thank you!

docs/docs/images/mcpgateway.gif

227 KB
Loading

0 commit comments

Comments
 (0)