Skip to content

Commit 6b2b0ce

Browse files
committed
Updated docs, favicon, closed #50 and included a media kit
Signed-off-by: Mihai Criveti <[email protected]>
1 parent ceb0a09 commit 6b2b0ce

File tree

6 files changed

+187
-19
lines changed

6 files changed

+187
-19
lines changed

.pre-commit-config.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ repos:
5656
#
5757
# • `:contentReference`
5858
# • `[oaicite:??<digits>]` (e.g. `[oaicite:??12345]`)
59+
# • source=chatgpt.com
5960
# • Stock phrases such as
6061
# – "As an AI language model"
6162
# – "I am an AI developed by"
@@ -88,7 +89,7 @@ repos:
8889
- id: forbid-ai-stock-phrases
8990
name: ❌ Forbid AI Stock Phrases
9091
description: Prevents common AI-generated phrases from being committed.
91-
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)'
92+
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)'
9293
language: pygrep
9394
types: [text]
9495
exclude: ^\.pre-commit-config\.yaml$

docs/base.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ markdown_extensions:
135135

136136
plugins:
137137
search: {}
138-
inline-svg: {}
138+
# inline-svg: {}
139139
table-reader: {}
140140
git-revision-date-localized:
141141
fallback_to_build_date: true

docs/docs/media/.pages

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
nav:
22
- "Overview": index.md
3-
- "Press": press
4-
- "Social": social
5-
- "Testimonials": testimonials
63
- "Media Kit": kit
4+
# - "Press": press
5+
- "Social": social
6+
# - "Testimonials": testimonials

docs/docs/media/kit/index.md

Lines changed: 181 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,188 @@
1-
# Media Kit
1+
# 🧰 Media Kit
22

3-
A one-stop kit for bloggers & press:
3+
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.
44

5-
- **Sample Announcement**
6-
A ready-made blog post template
5+
---
76

8-
- **Brand Guidelines**
9-
Logo usage, colors & fonts
7+
## 🤔 What is MCP (Model Context Protocol)?
108

11-
- **Logos**
12-
SVG/PNG assets
9+
[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.
1310

14-
- **Badges**
15-
Markdown badges & buttons
11+
It's widely supported by GitHub Copilot, Microsoft Copilot, AWS Bedrock, Google Cloud AI, IBM watsonx, and **15,000+ servers** in the community.
1612

17-
- **Social Templates**
18-
Pre-written tweets & LinkedIn copy
13+
### ⚡ Why it matters
1914

20-
- **Images**
21-
Hero banners & screenshots
15+
- ✅ Standardized interface contracts via typed JSON Schema
16+
- ✅ Supported across the ecosystem — GitHub/Microsoft Copilot, AWS Bedrock, Google Cloud AI, IBM watsonx, AgentBee, LangChain, CrewAI, and more
17+
- ✅ Strong ecosystem - **15,000+** MCP-compatible servers and multiple clients, with announcements from multiple major vendors
18+
19+
### ❌ Current challenges
20+
21+
- ❌ Fragmented transports: STDIO, SSE, HTTP — with some methods already deprecated
22+
- ❌ Inconsistent authentication: none, JWT, OAuth
23+
- ❌ Operational overhead: managing endpoints, credentials, retries, and logs for each tool
24+
- ❌ Version mismatch: clients and servers may support different MCP versions
25+
26+
---
27+
28+
## 💡 Why [ContextForge MCP Gateway](https://github.com/IBM/mcp-context-forge)?
29+
30+
> **Problem:** Most teams build one-off adapters for each tool or model, leading to maintenance burden and slow development.
31+
32+
[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.
33+
34+
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.
35+
36+
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.
37+
38+
| Pain Point | How Gateway Solves It |
39+
|--------------------------------------|--------------------------------------------------|
40+
| Transport fragmentation (STDIO/SSE/HTTP) | Unifies everything under HTTPS + JSON-RPC |
41+
| DIY wrappers & retry logic | Automatic, schema-validated retry handling |
42+
| Weak auth layers | Built-in JWT (or OAuth) & rate limiting |
43+
| No visibility | Per-call and per-server metrics & logging |
44+
| Onboarding difficulties | Built-in admin UI for tools, prompts, and resources |
45+
46+
![Architecture Overview](https://ibm.github.io/mcp-context-forge/images/mcpgateway.svg)
47+
48+
---
49+
50+
## 📑 Sample Announcements
51+
52+
???+ "📣 Non-Technical Post"
53+
### Meet ContextForge MCP Gateway: Simplify AI Tool Connections
54+
55+
Building AI agents should be easy—but each tool speaks a different dialect.
56+
57+
**[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.
58+
59+
> "What should be simple often becomes a debugging nightmare. The ContextForge MCP Gateway solves that." — Mihai Criveti
60+
61+
**Try it in 60 seconds:**
62+
```bash
63+
docker run -d --name mcpgateway \
64+
-p 4444:4444 \
65+
-e JWT_SECRET_KEY=YOUR_KEY \
66+
ghcr.io/ibm/mcp-context-forge:latest
67+
```
68+
69+
Please ⭐ the project on GitHub if you find this useful, it helps us grow!
70+
71+
???+ "🛠️ Technical Post"
72+
### Introducing ContextForge MCP Gateway: The Missing Proxy for AI Agents and Tools
73+
74+
**[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.
75+
76+
It includes schema-validated retries, JWT auth, and a built-in catalog UI.
77+
78+
**Docker:**
79+
```bash
80+
docker run -d --name mcpgateway \
81+
-p 4444:4444 \
82+
-e JWT_SECRET_KEY=YOUR_KEY \
83+
ghcr.io/ibm/mcp-context-forge:latest
84+
```
85+
86+
**PyPI:**
87+
```bash
88+
pip install mcp-gateway
89+
mcpgateway --host 0.0.0.0 --port 4444
90+
```
91+
92+
Please ⭐ the project on GitHub if you find this useful, it helps us grow!
93+
94+
---
95+
96+
???+ "🛠️ Connect Cline VS Code Extension to ContextForge MCP Gateway"
97+
98+
> A great idea is to create posts, videos or articles on using specific clients or with MCP Gateway.
99+
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:
100+
101+
### Connect your Cline extension to MCP Gateway
102+
103+
**[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.
104+
105+
**Start the Gateway (Docker):**
106+
```bash
107+
docker run -d --name mcpgateway \
108+
-p 4444:4444 \
109+
-e JWT_SECRET_KEY=YOUR_KEY \
110+
ghcr.io/ibm/mcp-context-forge:latest
111+
```
112+
113+
**Or install via PyPI:**
114+
115+
```bash
116+
pip install mcp-gateway
117+
mcpgateway --host 0.0.0.0 --port 4444
118+
```
119+
120+
⭐ Enjoying this? Leave a star on GitHub!
121+
122+
---
123+
124+
#### 🔍 What is Cline?
125+
126+
[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.
127+
128+
---
129+
130+
#### 🔐 Set up JWT Authentication
131+
132+
In your Cline settings, add an MCP server:
133+
134+
```json
135+
{
136+
"name": "MCP Gateway",
137+
"url": "http://localhost:4444",
138+
"auth": {
139+
"type": "bearer",
140+
"token": "<YOUR_JWT_TOKEN>"
141+
}
142+
}
143+
```
144+
145+
Enable the server in Cline—you should see a green "connected" indicator when authentication succeeds.
146+
147+
---
148+
149+
#### 🚀 Using MCP Tools in Cline
150+
151+
With the connection live, Cline can:
152+
153+
* Automatically list tools exposed by the Gateway
154+
* Use simple prompts to invoke tools, e.g.:
155+
156+
```
157+
Run the `list_files` tool with path: "./src"
158+
```
159+
* Display results and JSON output directly within the VS Code interface
160+
161+
Try it yourself—and don't forget to ⭐ the project at [ContextForge MCP Gateway](https://github.com/IBM/mcp-context-forge)!
162+
163+
164+
## 🖼️ Logo & Images
165+
166+
| Asset | URL |
167+
|-------|-----|
168+
| Transparent PNG logo | `https://ibm.github.io/mcp-context-forge/logo.png` |
169+
| Hero demo GIF | `https://ibm.github.io/mcp-context-forge/images/mcpgateway.gif` |
170+
| Architecture overview | [SVG](https://ibm.github.io/mcp-context-forge/images/mcpgateway.svg) |
171+
172+
---
173+
174+
## 📣 Social Snippets
175+
176+
**Tweet / X**
177+
178+
!!! example "Twitter / X"
179+
🚀 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
180+
181+
**LinkedIn**
182+
183+
!!! example
184+
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 ⭐!
185+
`#mcp #ai #tools`
186+
187+
!!! tip Examples Posts
188+
See [Social](../social/index.md) for example articles and social media posts - and add your own there once published!

docs/theme/logo-small.png

6.69 KB
Loading

docs/theme/logo.png

235 KB
Loading

0 commit comments

Comments
 (0)