Skip to content

[Docs]: Several minor quirks in main README.md #1159

@isippli

Description

@isippli

📚 Documentation Issue Summary

  1. In https://github.com/IBM/mcp-context-forge/blob/main/README.md#quick-start---containers
    does not mention that the container image is x86 only. When trying to deploy, I got the following error
    WARNING: image platform (linux/amd64) does not match the expected platform (linux/arm64)

  2. In "🚀 End-to-end demo (register a local MCP server)"

This section:

# 2️⃣  Register it with the gateway
curl -s -X POST -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{"name":"fast_time","url":"http://localhost:9000/sse"}' \
     http://localhost:4444/gateways

uses port 9000. However, the command to spin up the fast-time server uses port 8003.


📍 Location of the Problem

./README.md


✏️ Type of Issue

  • Typo or formatting issue
  • Outdated or incorrect information
  • Missing explanation or example
  • Unclear instructions
  • Other (explain below)

💡 Suggested Fix or Clarification (optional)

For 1:
Suggest to modify from

Use the official OCI image from GHCR with **Docker** *or* **Podman**.

to

Use the official OCI image from GHCR with **Docker** *or* **Podman**. Please note: Currently, amd64 is not supported. If you are e.g. running on MacOS, install via PyPi.

  1. Modify the port, as such:

curl -s -X POST -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" \ -H "Content-Type: application/json" \ -d '{"name":"fast_time","url":"http://localhost:8003/sse"}' \ http://localhost:4444/gateways


🧠 Environment (optional)

N/A


🧩 Additional Notes (optional)

N/A

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationtriageIssues / Features awaiting triage

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions