Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ja8zyjits merged 2 commits into from
Sep 14, 2026
+18 −6
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9221587
docs: correct incorrect package and image references in ADR-025 and a…
brian-hussey Sep 11, 2026
f4e99ef
docs: fix incorrect pip package names in translate and reverse-proxy …
brian-hussey Sep 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions docs/docs/architecture/adr/025-granian-http-server.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,19 +194,31 @@ make container-run CONTAINER_HTTP_SERVER=granian
make container-run CONTAINER_SSL=1 CONTAINER_HTTP_SERVER=granian

# Or pass HTTP_SERVER directly
docker run mcpgateway/mcpgateway # Gunicorn (default)
docker run -e HTTP_SERVER=granian mcpgateway/mcpgateway # Granian
docker run ghcr.io/ibm/mcp-context-forge:latest # Gunicorn (default)
docker run -e HTTP_SERVER=granian ghcr.io/ibm/mcp-context-forge:latest # Granian
```

!!! note "Historical document — commands above are illustrative only"
This ADR is superseded by [ADR-054](054-remove-granian-http-server.md) and retained for architectural record only.
The `docker run` references above contained incorrect image references and have been retroactively corrected
for security reasons. These commands are not guaranteed to work as shown — consult the current deployment
documentation instead.

## Switching Servers

To switch from Gunicorn to Granian:

1. Install Granian: `pip install "mcpgateway[granian]"`
1. Install Granian: `pip install "mcp-contextforge-gateway[granian]"`
2. Test locally: `make serve-granian`
3. Benchmark both servers with your workload
4. If Granian performs better, set `HTTP_SERVER=granian` in your deployment

!!! note "Historical document — command above is illustrative only"
This ADR is superseded by [ADR-054](054-remove-granian-http-server.md) and retained for architectural record only.
The `pip install` reference above contained an incorrect package reference and has been retroactively corrected
for security reasons. Note also that the `granian` extra was subsequently removed (see ADR-054); this step is
no longer valid for current versions of ContextForge.

## Files Changed

| File | Change |
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/using/mcpgateway-translate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -423,7 +423,7 @@ curl -X POST http://localhost:9000/message \

```dockerfile
FROM python:3.11-slim
RUN pip install mcpgateway mcp
RUN pip install mcp-contextforge-gateway mcp
EXPOSE 8000
HEALTHCHECK CMD curl -f http://localhost:8000/healthz || exit 1
CMD ["python", "-m", "mcpgateway.translate", \
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/using/reverse-proxy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ python3 -m mcpgateway.reverse_proxy --config reverse-proxy.yaml
FROM python:3.11-slim

# Install MCP gateway and server
RUN pip install mcp-gateway mcp-server-git
RUN pip install mcp-contextforge-gateway mcp-server-git

# Set environment
ENV REVERSE_PROXY_GATEWAY=https://gateway.example.com
Expand Down
2 changes: 1 addition & 1 deletion plugins/altk_json_processor/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Note that this plugin will require calling an LLM and will therefore require con
## Installation

1. Enable the "ALTKJsonProcessor" plugin in `plugins/config.yaml`.
2. Install the optional dependency `altk` (i.e. `pip install mcp-context-forge[altk]`)
2. Install the optional dependency `altk` (i.e. `pip install mcp-contextforge-gateway[altk]`)
Comment thread
gandhipratik203 marked this conversation as resolved.
3. Configure a LLM provider as described below.

## Configuration
Expand Down
Loading