Proposed README edits - #18
Open
a-effort wants to merge 2 commits into
Open
Conversation
a-effort
marked this pull request as ready for review
August 12, 2026 19:44
a-effort
force-pushed
the
readme/clarify-contextforge-dev-step
branch
from
August 13, 2026 00:29
eebd633 to
d3583aa
Compare
gcgoncalves
reviewed
Aug 13, 2026
gcgoncalves
left a comment
gcgoncalves
left a comment
Contributor
There was a problem hiding this comment.
The current version uses ContextForge, and the proposed mcp-context-forge. Both here are old terms, we're trying to distance away from MCP - as the gateway is broader in scope. Let's use just Context Forge.
Refer to the backing service as the ContextForge API rather than "the gateway", "ContextForge MCP Gateway", or "mcp-context-forge". "Gateway" is ambiguous here: it is also a domain entity (GatewayCreate/GatewayRead, /v1/gateways, Gateways.tsx), so "point the BFF at the gateway" read as if a gateway had to be created first. The repo slug is now confined to links and clone paths. Add a component table up front so the body can use short forms, and lead with "AI gateway" as category framing rather than a referring term. Also fix two leftovers from when this lived inside mcp-context-forge: CI workflow links pointed at ../.github/, and the structure tree was rooted at client/. Signed-off-by: Anna Effort <anna.effort@ibm.com>
a-effort
force-pushed
the
readme/clarify-contextforge-dev-step
branch
from
August 19, 2026 00:56
914d4a2 to
8b32b7f
Compare
Use colons or semicolons for label separators and clause joins instead of em dashes and hyphens, consistently across the definition lists. Signed-off-by: Anna Effort <anna.effort@ibm.com>
Contributor
Author
|
Heads up that I rebased onto current main, so both inline comments may show as outdated. What changed:
|
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
3 participants
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.
Changes proposed:
make devand its default port (:8000).FASTAPI_URLguidance:.env.example's4444default is mcp-context-forge's production default (make serve), notmake dev's:8000. Following the doc literally against amake devinstance pointed the BFF at the wrong port.mcp-context-forge(upstream gateway) fromcontextforge-web-ui(this repo) throughout. The similar names made several "ContextForge" / "this repo" references ambiguous about which project was meant.