Merge pull request #62 from IBM/documentation-updates

crivetimihai · web-flow · commit 06138c6d7e63 · 2025-06-08T09:12:34.000+01:00
Documentation updates and media kit
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -56,6 +56,7 @@ repos:
   #
   #   • `:contentReference`
   #   • `[oaicite:??<digits>]` (e.g. `[oaicite:??12345]`)
+  #   • source=chatgpt.com
   #   • Stock phrases such as
   #       – "As an AI language model"
   #       – "I am an AI developed by"
@@ -88,7 +89,7 @@ repos:
       - id: forbid-ai-stock-phrases
         name: ❌ Forbid AI Stock Phrases
         description: Prevents common AI-generated phrases from being committed.
-        entry: '(?i)(as an ai language model|i am an ai developed by|this response was generated by|i don''t have real-time information|i don''t have access to real-time|i can''t browse the internet|i cannot browse the internet|my knowledge cutoff|my training data|i''m not able to access|i don''t have the ability to)'
+        entry: '(?i)(source=chatgpt.com|turn0search0|as an ai language model|i am an ai developed by|this response was generated by|i don''t have real-time information|i don''t have access to real-time|i can''t browse the internet|i cannot browse the internet|my knowledge cutoff|my training data|i''m not able to access|i don''t have the ability to)'
         language: pygrep
         types: [text]
         exclude: ^\.pre-commit-config\.yaml$
diff --git a/README.md b/README.md
diff --git a/docs/base.yml b/docs/base.yml
@@ -135,7 +135,7 @@ markdown_extensions:
 
 plugins:
   search: {}
-  inline-svg: {}
+  # inline-svg: {}
   table-reader: {}
   git-revision-date-localized:
     fallback_to_build_date: true
diff --git a/docs/create.sh b/docs/create.sh
diff --git a/docs/docs/.pages b/docs/docs/.pages
@@ -1,9 +1,10 @@
 nav:
   - "🏠 Home": index.md
   - "🧭 Overview": overview
-  - "🧰 Using": using
-  - "🚀 Deployment": deployment
+  - "🧰 Use": using
+  - "🚀 Deploy": deployment
   - "🛡️ Manage": manage
-  - "💻 Development": development
-  - "🧪 Testing": testing
+  - "💻 Develop": development
+  - "🧪 Test": testing
   - "📐 Architecture": architecture
+  - "📰 Media": media
diff --git a/docs/docs/architecture/.pages b/docs/docs/architecture/.pages
@@ -1,4 +1,3 @@
-title: Architecture
 nav:
   - Overview: index.md
   - Decision Records: adr
diff --git a/docs/docs/deployment/.pages b/docs/docs/deployment/.pages
@@ -1,4 +1,3 @@
-title: Deployment
 nav:
   - index.md
   - local.md
diff --git a/docs/docs/development/.pages b/docs/docs/development/.pages
@@ -1,4 +1,3 @@
-title: Development
 nav:
   - index.md
   - github.md
diff --git a/docs/docs/manage/.pages b/docs/docs/manage/.pages
@@ -1,4 +1,3 @@
-title: Management
 nav:
   - index.md
   - backup.md
diff --git a/docs/docs/media/.pages b/docs/docs/media/.pages
@@ -0,0 +1,6 @@
+nav:
+  - "Overview": index.md
+  - "Media Kit": kit
+  # - "Press": press
+  - "Social": social
+  # - "Testimonials": testimonials
diff --git a/docs/docs/media/index.md b/docs/docs/media/index.md
@@ -0,0 +1,8 @@
+# Media
+
+This section collects press coverage, social-media highlights, customer testimonials, and a ready-to-use media kit:
+
+- [Press Coverage](press/index.md)
+- [Social Highlights](social/index.md)
+- [Testimonials](testimonials/index.md)
+- [Media Kit](kit/index.md)
diff --git a/docs/docs/media/kit/.pages b/docs/docs/media/kit/.pages
@@ -0,0 +1,2 @@
+nav:
+  - "Media Kit": index.md
diff --git a/docs/docs/media/kit/index.md b/docs/docs/media/kit/index.md
@@ -0,0 +1,188 @@
+# 🧰 Media Kit
+
+Everything you need to write about **[ContextForge MCP Gateway](https://github.com/IBM/mcp-context-forge)**—assets, ready-to-use copy, badges, images, and quick-start commands.
+
+---
+
+## 🤔 What is MCP (Model Context Protocol)?
+
+[MCP](https://modelcontextprotocol.io/introduction) is an open-source protocol released by Anthropic in **November 2024** that lets AI agents communicate with external tools through a standard JSON-RPC envelope. It's often described as the "USB-C of AI"—a universal connector for language models.
+
+It's widely supported by GitHub Copilot, Microsoft Copilot, AWS Bedrock, Google Cloud AI, IBM watsonx, and **15,000+ servers** in the community.
+
+### ⚡ Why it matters
+
+- ✅ Standardized interface contracts via typed JSON Schema
+- ✅ Supported across the ecosystem — GitHub/Microsoft Copilot, AWS Bedrock, Google Cloud AI, IBM watsonx, AgentBee, LangChain, CrewAI, and more
+- ✅ Strong ecosystem - **15,000+** MCP-compatible servers and multiple clients, with announcements from multiple major vendors
+
+### ❌ Current challenges
+
+- ❌ Fragmented transports: STDIO, SSE, HTTP — with some methods already deprecated
+- ❌ Inconsistent authentication: none, JWT, OAuth
+- ❌ Operational overhead: managing endpoints, credentials, retries, and logs for each tool
+- ❌ Version mismatch: clients and servers may support different MCP versions
+
+---
+
+## 💡 Why [ContextForge MCP Gateway](https://github.com/IBM/mcp-context-forge)?
+
+> **Problem:** Most teams build one-off adapters for each tool or model, leading to maintenance burden and slow development.
+
+[ContextForge MCP Gateway](https://github.com/IBM/mcp-context-forge) solves this by proxying all MCP and REST tool servers through a **single HTTPS + JSON-RPC endpoint**, with discovery, security, and observability built in.
+
+It lets you create Virtual Servers - remixing tools/prompts/resources from multiple servers, introduce strong Auth - and change protocol versions on the fly. It lets you easily create new MCP Servers without having to write any code - by proxing existing REST services.
+
+And is readily available as open source, published a container image and as a Python module published on PyPi - so you can get started with a single command - and scale all the way up to multi-regional Kubernetes clusters.
+
+| Pain Point                           | How Gateway Solves It                            |
+|--------------------------------------|--------------------------------------------------|
+| Transport fragmentation (STDIO/SSE/HTTP) | Unifies everything under HTTPS + JSON-RPC    |
+| DIY wrappers & retry logic           | Automatic, schema-validated retry handling       |
+| Weak auth layers                     | Built-in JWT (or OAuth) & rate limiting          |
+| No visibility                        | Per-call and per-server metrics & logging        |
+| Onboarding difficulties              | Built-in admin UI for tools, prompts, and resources |
+
+![Architecture Overview](https://ibm.github.io/mcp-context-forge/images/mcpgateway.svg)
+
+---
+
+## 📑 Sample Announcements
+
+???+ "📣 Non-Technical Post"
+    ### Meet ContextForge MCP Gateway: Simplify AI Tool Connections
+
+    Building AI agents should be easy—but each tool speaks a different dialect.
+
+    **[ContextForge MCP Gateway](https://github.com/IBM/mcp-context-forge)** is a universal hub: one secure endpoint that discovers your tools and works seamlessly with Copilot, CrewAI, LangChain, and more.
+
+    > "What should be simple often becomes a debugging nightmare. The ContextForge MCP Gateway solves that." — Mihai Criveti
+
+    **Try it in 60 seconds:**
+    ```bash
+    docker run -d --name mcpgateway \
+      -p 4444:4444 \
+      -e JWT_SECRET_KEY=YOUR_KEY \
+      ghcr.io/ibm/mcp-context-forge:latest
+    ```
+
+    Please ⭐ the project on GitHub if you find this useful, it helps us grow!
+
+???+ "🛠️ Technical Post"
+    ### Introducing ContextForge MCP Gateway: The Missing Proxy for AI Agents and Tools
+
+    **[ContextForge MCP Gateway](https://github.com/IBM/mcp-context-forge)** normalizes STDIO, SSE, REST, and HTTP MCP servers into one HTTPS + JSON-RPC interface with full MCP support.
+
+    It includes schema-validated retries, JWT auth, and a built-in catalog UI.
+
+    **Docker:**
+    ```bash
+    docker run -d --name mcpgateway \
+      -p 4444:4444 \
+      -e JWT_SECRET_KEY=YOUR_KEY \
+      ghcr.io/ibm/mcp-context-forge:latest
+    ```
+
+    **PyPI:**
+    ```bash
+    pip install mcp-gateway
+    mcpgateway --host 0.0.0.0 --port 4444
+    ```
+
+    Please ⭐ the project on GitHub if you find this useful, it helps us grow!
+
+---
+
+???+ "🛠️ Connect Cline VS Code Extension to ContextForge MCP Gateway"
+
+    > A great idea is to create posts, videos or articles on using specific clients or with MCP Gateway.
+    Provide details on how to run and register a number of useful MCP Servers, adding them to the gateway, then using specific clients to connect. For example, Visual Studio Cline, GitHub Copilot, Langchain, etc. Example:
+
+    ### Connect your Cline extension to MCP Gateway
+
+    **[ContextForge MCP Gateway](https://github.com/IBM/mcp-context-forge)** offers a unified HTTPS + JSON‑RPC endpoint for AI tools, making integration seamless—including with **Cline**, a VS Code extension that supports MCP.
+
+    **Start the Gateway (Docker):**
+    ```bash
+    docker run -d --name mcpgateway \
+      -p 4444:4444 \
+      -e JWT_SECRET_KEY=YOUR_KEY \
+      ghcr.io/ibm/mcp-context-forge:latest
+    ```
+
+    **Or install via PyPI:**
+
+    ```bash
+    pip install mcp-gateway
+    mcpgateway --host 0.0.0.0 --port 4444
+    ```
+
+    ⭐ Enjoying this? Leave a star on GitHub!
+
+    ---
+
+    #### 🔍 What is Cline?
+
+    [Cline](https://cline.bot/) is a powerful AI coding assistant for VS Code. It supports MCP, allowing it to discover and use tools provided through MCP Gateway.
+
+    ---
+
+    #### 🔐 Set up JWT Authentication
+
+    In your Cline settings, add an MCP server:
+
+    ```json
+    {
+      "name": "MCP Gateway",
+      "url": "http://localhost:4444",
+      "auth": {
+        "type": "bearer",
+        "token": "<YOUR_JWT_TOKEN>"
+      }
+    }
+    ```
+
+    Enable the server in Cline—you should see a green "connected" indicator when authentication succeeds.
+
+    ---
+
+    #### 🚀 Using MCP Tools in Cline
+
+    With the connection live, Cline can:
+
+    * Automatically list tools exposed by the Gateway
+    * Use simple prompts to invoke tools, e.g.:
+
+      ```
+      Run the `list_files` tool with path: "./src"
+      ```
+    * Display results and JSON output directly within the VS Code interface
+
+    Try it yourself—and don't forget to ⭐ the project at [ContextForge MCP Gateway](https://github.com/IBM/mcp-context-forge)!
+
+
+## 🖼️ Logo & Images
+
+| Asset | URL |
+|-------|-----|
+| Transparent PNG logo  | `https://ibm.github.io/mcp-context-forge/logo.png` |
+| Hero demo GIF         | `https://ibm.github.io/mcp-context-forge/images/mcpgateway.gif` |
+| Architecture overview | [SVG](https://ibm.github.io/mcp-context-forge/images/mcpgateway.svg) |
+
+---
+
+## 📣 Social Snippets
+
+**Tweet / X**
+
+!!! example "Twitter / X"
+    🚀 ContextForge MCP Gateway is now open source! One endpoint to unify & secure AI-tool connections (STDIO, SSE, REST). Give it a spin and drop a ⭐ → https://github.com/IBM/mcp-context-forge #mcp #ai #tools
+
+**LinkedIn**
+
+!!! example
+    Thrilled to share **ContextForge MCP Gateway**—an open-source hub that turns fragmented AI-tool integrations into a single secure interface with discovery, observability, and a live catalog UI. Check it out on GitHub and leave us a star ⭐!
+    `#mcp #ai #tools`
+
+!!! tip Examples Posts
+    See [Social](../social/index.md) for example articles and social media posts - and add your own there once published!
diff --git a/docs/docs/media/press/.pages b/docs/docs/media/press/.pages
@@ -0,0 +1,2 @@
+nav:
+  - "Press Coverage": index.md
diff --git a/docs/docs/media/press/index.md b/docs/docs/media/press/index.md
@@ -0,0 +1 @@
+# Press
diff --git a/docs/docs/media/social/.pages b/docs/docs/media/social/.pages
@@ -0,0 +1,2 @@
+nav:
+  - "Social Highlights": index.md
diff --git a/docs/docs/media/social/index.md b/docs/docs/media/social/index.md
@@ -0,0 +1,17 @@
+# Social Highlights
+
+## Articles
+!!! details "MCP Gateway: The Missing Proxy for AI Tools (Medium)"
+    **Author:** Mihai Criveti | **Date:** June 8, 2025 | **6 min read**
+    [Read on Medium](https://medium.com/@crivetimihai/mcp-gateway-the-missing-proxy-for-ai-tools-2b16d3b018d5)
+
+    !!! quote
+        "AI agents and tool integration are exciting — until you actually try to connect them. Different authentication systems (or none), fragmented documentation, and incompatible protocols quickly turn what should be simple integrations into debugging nightmares. MCP Gateway solves this."
+
+
+!!! details "MCP Gateway Launch Announcement (LinkedIn)"
+    **Author:** Mihai Criveti | **Date:** June 5, 2025
+    [View on LinkedIn](https://www.linkedin.com/posts/crivetimihai_ibm-opensource-mcp-activity-7335982903681581056-29Oc)
+
+    !!! quote
+        "Just open-sourced something I've been building – the MCP Gateway: turn any REST API into an MCP server, connect multiple MCP servers, combine tools into virtual servers, swap them on the fly, and adds observability and security – all in one container that can be deployed anywhere."
diff --git a/docs/docs/media/testimonials/.pages b/docs/docs/media/testimonials/.pages
@@ -0,0 +1,2 @@
+nav:
+  - "Testimonials": index.md
diff --git a/docs/docs/media/testimonials/index.md b/docs/docs/media/testimonials/index.md
@@ -0,0 +1,6 @@
+# Testimonials
+
+## Platforms
+
+- **IBM Consulting Advantage**
+  [IBM Consulting Advantage](https://www.ibm.com/consulting/advantage) - AI-tooling platform, equipping 160,000 expert consultants with role, industry and business domain-specific AI assistants, agents, and applications.
diff --git a/docs/docs/overview/.pages b/docs/docs/overview/.pages
@@ -1,4 +1,3 @@
-title: Overview
 nav:
   - index.md
   - features.md
diff --git a/docs/docs/testing/.pages b/docs/docs/testing/.pages
diff --git a/docs/docs/using/.pages b/docs/docs/using/.pages
diff --git a/docs/theme/favicon.ico b/docs/theme/favicon.ico
diff --git a/docs/theme/logo-small.png b/docs/theme/logo-small.png
diff --git a/docs/theme/logo.png b/docs/theme/logo.png

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-title: Deployment`
`2`	`1`	`nav:`
`3`	`2`	`- index.md`
`4`	`3`	`- local.md`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-title: Development`
`2`	`1`	`nav:`
`3`	`2`	`- index.md`
`4`	`3`	`- github.md`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-title: Management`
`2`	`1`	`nav:`
`3`	`2`	`- index.md`
`4`	`3`	`- backup.md`