Skip to content

docs: correct incorrect package and image references in ADR-025 and altk README - #6788

Merged
ja8zyjits merged 2 commits into
mainfrom
fix/security-incorrect-package-image-refs-in-docs
Sep 14, 2026
Merged

docs: correct incorrect package and image references in ADR-025 and altk README#6788
ja8zyjits merged 2 commits into
mainfrom
fix/security-incorrect-package-image-refs-in-docs

Conversation

@brian-hussey

@brian-hussey brian-hussey commented Sep 11, 2026

Copy link
Copy Markdown
Member

Summary

Retroactively corrects documentation files that contained incorrect package and container image references. These references posed a potential security concern and have been corrected to the canonical values.

Partially addresses internal issue #625.

Changes

docs/docs/architecture/adr/025-granian-http-server.md

  • Corrected docker run examples to use the canonical ghcr.io/ibm/mcp-context-forge:latest image
  • Corrected pip install reference to use the canonical mcp-contextforge-gateway[granian] package name
  • Added !!! note admonitions after both blocks clarifying this is a superseded historical ADR, that the references were incorrect and have been retroactively corrected for security reasons, and that readers should consult current documentation

plugins/altk_json_processor/README.md

  • Corrected pip install mcp-context-forge[altk]pip install mcp-contextforge-gateway[altk] to match the canonical package name

docs/docs/using/mcpgateway-translate.md

  • Corrected RUN pip install mcpgateway mcpRUN pip install mcp-contextforge-gateway mcp in the Container Deployment Dockerfile example (mcpgateway is not a published PyPI package)

docs/docs/using/reverse-proxy.md

  • Corrected RUN pip install mcp-gateway mcp-server-gitRUN pip install mcp-contextforge-gateway mcp-server-git in the Container Deployment Dockerfile example (mcp-gateway is not the correct package name)

Testing

Documentation-only change. Pre-commit hooks passed (detect-secrets, ruff, etc.).

@ja8zyjits

Copy link
Copy Markdown
Collaborator

@brian-hussey
Granian is out of the way #5556

@brian-hussey

Copy link
Copy Markdown
Member Author

@brian-hussey Granian is out of the way #5556

Yes, this is a reference to a incorrect package or container image name and is still a risk in our documentation even if it's a historical or theoretical. I've pinged you about this as well @ja8zyjits, thanks.

…ltk README

ADR-025 (superseded, retained for historical record) contained docker run
and pip install references that were incorrect and posed a potential security
concern. Retroactively corrected to canonical references and added notes
clarifying these are historical commands only.

plugins/altk_json_processor/README.md contained an incorrect pip install
package name. Corrected to the canonical mcp-contextforge-gateway[altk].

Fixes: #75, #76 (brian-hussey/workflow_mgr)
Signed-off-by: Brian Hussey <brian.hussey@ie.ibm.com>
@brian-hussey
brian-hussey force-pushed the fix/security-incorrect-package-image-refs-in-docs branch from e9d2cce to 9221587 Compare September 11, 2026 14:03
ja8zyjits
ja8zyjits previously approved these changes Sep 11, 2026

@ja8zyjits ja8zyjits left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Comment thread plugins/altk_json_processor/README.md

@gandhipratik203 gandhipratik203 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. I have added is a inline suggestion comment, non blocking for this PR.

@brian-hussey
brian-hussey marked this pull request as draft September 11, 2026 15:47
…Dockerfiles

Replace 'mcpgateway' and 'mcp-gateway' (non-existent PyPI packages) with
the canonical 'mcp-contextforge-gateway' in Dockerfile examples in:
- docs/docs/using/mcpgateway-translate.md
- docs/docs/using/reverse-proxy.md

Partially addresses internal issue #625.

Signed-off-by: Brian Hussey <brian.hussey@ie.ibm.com>
@brian-hussey
brian-hussey marked this pull request as ready for review September 11, 2026 16:38

@gandhipratik203 gandhipratik203 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@ja8zyjits ja8zyjits left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ja8zyjits
ja8zyjits added this pull request to the merge queue Sep 14, 2026
Merged via the queue into main with commit 3dfdd5e Sep 14, 2026
40 of 48 checks passed
@ja8zyjits
ja8zyjits deleted the fix/security-incorrect-package-image-refs-in-docs branch September 14, 2026 09:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants