@eznix/mcp-gateway 1.3.3

package/.dockerignore

@@ -0,0 +1,8 @@
+node_modules
+.bun
+dist
+*.log
+.git
+.gitignore
+.env
+*.local

package/.github/workflows/docker.yml

@@ -0,0 +1,51 @@
+name: Docker Build & Publish
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  contents: read
+  packages: write
+
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Login to GHCR
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata for Docker
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ghcr.io/${{ github.repository_owner }}/mcp-gateway
+          tags: |
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}
+            type=semver,pattern={{major}}.{{minor}}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          platforms: linux/amd64,linux/arm64
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max

package/.github/workflows/npm.yml

@@ -0,0 +1,53 @@
+name: Publish to npm (Bun)
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: latest
+
+      - name: Cache dependencies
+        uses: actions/cache@v5
+        with:
+          path: |
+            ~/.bun/install/cache
+          key: ${{ runner.os }}-bun-${{ hashFiles('**/bun.lock') }}
+
+      - name: Install dependencies
+        run: bun install --frozen-lockfile
+
+      - name: Build package
+        run: bun run build
+
+      - name: Publish to npm
+        if: startsWith(github.ref, 'refs/tags/v')
+        env:
+          NPM_CONFIG_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: bun publish --verbose -p --access public
+
+      - name: Update CHANGELOG
+        id: changelog
+        uses: requarks/changelog-action@v1
+        with:
+          token: ${{ github.token }}
+          tag: ${{ github.ref_name }}
+          useGitmojis: false
+
+      - name: Create Release
+        uses: softprops/action-gh-release@v2
+        with:
+          body: ${{ steps.changelog.outputs.changes }}

package/AGENTS.md

@@ -0,0 +1,111 @@
+---
+description: Use Bun instead of Node.js, npm, pnpm, or vite.
+globs: "*.ts, *.tsx, *.html, *.css, *.js, *.jsx, package.json"
+alwaysApply: false
+---
+
+Default to using Bun instead of Node.js.
+
+- Use `bun <file>` instead of `node <file>` or `ts-node <file>`
+- Use `bun test` instead of `jest` or `vitest`
+- Use `bun build <file.html|file.ts|file.css>` instead of `webpack` or `esbuild`
+- Use `bun install` instead of `npm install` or `yarn install` or `pnpm install`
+- Use `bun run <script>` instead of `npm run <script>` or `yarn run <script>` or `pnpm run <script>`
+- Use `bunx <package> <command>` instead of `npx <package> <command>`
+- Bun automatically loads .env, so don't use dotenv.
+
+## APIs
+
+- `Bun.serve()` supports WebSockets, HTTPS, and routes. Don't use `express`.
+- `bun:sqlite` for SQLite. Don't use `better-sqlite3`.
+- `Bun.redis` for Redis. Don't use `ioredis`.
+- `Bun.sql` for Postgres. Don't use `pg` or `postgres.js`.
+- `WebSocket` is built-in. Don't use `ws`.
+- Prefer `Bun.file` over `node:fs`'s readFile/writeFile
+- Bun.$`ls` instead of execa.
+
+## Testing
+
+Use `bun test` to run tests.
+
+```ts#index.test.ts
+import { test, expect } from "bun:test";
+
+test("hello world", () => {
+  expect(1).toBe(1);
+});
+```
+
+## Frontend
+
+Use HTML imports with `Bun.serve()`. Don't use `vite`. HTML imports fully support React, CSS, Tailwind.
+
+Server:
+
+```ts#index.ts
+import index from "./index.html"
+
+Bun.serve({
+  routes: {
+    "/": index,
+    "/api/users/:id": {
+      GET: (req) => {
+        return new Response(JSON.stringify({ id: req.params.id }));
+      },
+    },
+  },
+  // optional websocket support
+  websocket: {
+    open: (ws) => {
+      ws.send("Hello, world!");
+    },
+    message: (ws, message) => {
+      ws.send(message);
+    },
+    close: (ws) => {
+      // handle close
+    }
+  },
+  development: {
+    hmr: true,
+    console: true,
+  }
+})
+```
+
+HTML files can import .tsx, .jsx or .js files directly and Bun's bundler will transpile & bundle automatically. `<link>` tags can point to stylesheets and Bun's CSS bundler will bundle.
+
+```html#index.html
+<html>
+  <body>
+    <h1>Hello, world!</h1>
+    <script type="module" src="./frontend.tsx"></script>
+  </body>
+</html>
+```
+
+With the following `frontend.tsx`:
+
+```tsx#frontend.tsx
+import React from "react";
+import { createRoot } from "react-dom/client";
+
+// import .css files directly and it works
+import './index.css';
+
+const root = createRoot(document.body);
+
+export default function Frontend() {
+  return <h1>Hello, world!</h1>;
+}
+
+root.render(<Frontend />);
+```
+
+Then, run index.ts
+
+```sh
+bun --hot ./index.ts
+```
+
+For more information, read the Bun API docs in `node_modules/bun-types/docs/**.mdx`.

package/Dockerfile

@@ -0,0 +1,22 @@
+FROM oven/bun:1-alpine
+
+RUN adduser -D -s /bin/sh gateway
+
+WORKDIR /app
+
+COPY package.json bun.lock ./
+RUN bun install
+
+COPY . .
+
+RUN bun build src/docker.ts --target=bun --outfile=/app/gateway
+
+# Create config directory for non-root user
+RUN mkdir -p /home/gateway/.config/mcp-gateway && chown -R gateway:gateway /home/gateway
+
+# Use non-root user
+USER gateway
+
+EXPOSE 3000
+
+CMD ["/app/gateway"]

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Bruno Bernard
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,292 @@
+# MCP Gateway
+
+[![npm version](https://img.shields.io/npm/v/@eznix/mcp-gateway)](https://www.npmjs.com/package/@eznix/mcp-gateway)
+[![npm downloads](https://img.shields.io/npm/dm/@eznix/mcp-gateway)](https://www.npmjs.com/package/@eznix/mcp-gateway)
+[![License](https://img.shields.io/npm/l/@eznix/mcp-gateway)](LICENSE)
+[![GitHub stars](https://img.shields.io/github/stars/eznix86/mcp-gateway)](https://github.com/eznix86/mcp-gateway/stargazers)
+
+MCP Gateway is a server aggregation tool that connects multiple Model Context Protocol (MCP) servers into a single gateway, exposing all tools from connected servers through unified search, describe, and invoke interfaces and it exposes only 5 tools.
+
+## The Context Limit Problem
+
+When connecting an client (Claude Code, Opencode, etc.) to multiple MCP servers, each server lists all its tools. With 10+ MCPs each exposing 10-50 tools, you can easily exceed 500+ tool descriptions in the system prompt:
+
+```
+10 servers × 20 tools each = 200+ tool descriptions
+Each tool: 200-500 chars → 40KB-100KB of description just for tool schemas!
+```
+
+This creates two problems:
+1. **Context overflow**: Many LLMs hit their context limit before any conversation happens
+2. **Cognitive overload**: LLMs struggle to choose the right tool from hundreds of options
+
+## The Gateway Solution
+
+MCP Gateway solves this by providing **tool search** instead of dumping all tool schemas:
+
+```
+┌─────────────┐    gateway.search    ┌─────────────────┐    kubernetes::pods_list    ┌──────────────────┐
+│  AI Client  │ ───────────────────► │   MCP Gateway   │ ─────────────────────────►  │  Kubernetes MCP  │
+│             │                      │                 │                             │                  │
+│             │ ◄────────────────────│                 │ ◄─────────────────────────  │                  │
+└─────────────┘   pods_list schema   └─────────────────┘         pods output         └──────────────────┘
+```
+
+## How It Works
+
+MCP Gateway operates as both an MCP client (connecting to upstream servers) and an MCP server (exposing tools to downstream clients):
+
+```
+┌──────────────┐      MCP       ┌─────────────────┐      MCP       ┌──────────────────┐
+│  AI Client   │ ◄────────────  │   MCP Gateway   │ ◄────────────  │  Upstream Server │
+│ (Claude, etc)│                │  (this gateway) │                │  (playwright,    │
+└──────────────┘                └─────────────────┘                │   kubernetes...) │
+                                                                   └──────────────────┘
+```
+
+1. Gateway starts and reads configuration
+2. For each configured upstream server, Gateway connects via stdio (local) or HTTP/WebSocket (remote)
+3. Gateway fetches the tool catalog from each server
+4. All tools are indexed in a unified catalog with search capabilities
+5. AI clients connect to Gateway and use `gateway.search` to find relevant tools
+6. Only the tools the client actually needs are invoked
+
+You will notice around ~40% reduction of initial token used.
+
+## Installation
+
+### Claude Code
+
+Add to your Claude MCP configuration:
+
+```json
+{
+  "mcpServers": {
+    "gateway": {
+      "command": "bunx",
+      "args": ["@eznix/mcp-gateway@latest"]
+    }
+  }
+}
+```
+
+### OpenCode
+
+Add to your OpenCode MCP configuration:
+
+```json
+{
+  "$schema": "https://opencode.ai/config.json",
+  "mcp": {
+    "mcp-gateway": {
+      "type": "local",
+      "command": ["bunx", "@eznix/mcp-gateway@latest"]
+    },
+  }
+}
+```
+
+You may append your global AGENTS.md (`~/.config/opencode/AGENTS.md`) with this [template](./templates/AGENTS.md).
+
+You may now just simple enumerate the MCP available.
+
+## Configuration
+
+MCP Gateway reads configuration from a JSON file. By default, it looks for:
+
+1. Path provided as first command-line argument
+2. `MCP_GATEWAY_CONFIG` environment variable
+3. `~/.config/mcp-gateway/config.json`
+
+### Configuration Format
+
+```json
+{
+  "local-server": {
+    "type": "local",
+    "command": ["bun", "run", "/path/to/server.ts"],
+  },
+  "remote-server": {
+    "type": "remote",
+    "url": "https://mcp.example.com",
+    "enabled": true
+  },
+  "websocket-server": {
+    "type": "remote",
+    "url": "wss://mcp.example.com/ws",
+    "enabled": true
+  }
+}
+```
+
+Each entry specifies:
+- `type`: `"local"` or `"remote"`
+- `command` (local only): Array with command and arguments to spawn the upstream server
+- `url` (remote only): Full URL of the remote MCP server
+- `transport` (optional, remote only): Override transport detection (`"streamable_http"` or `"websocket"`). Usually auto-detected from URL protocol.
+- `enabled`: Set to false to skip connecting to this server
+
+### Docker
+
+Run MCP Gateway in Docker with HTTP transport:
+
+```bash
+# Build the image
+docker build -t mcp-gateway .
+
+# Run with config mounted
+docker run -p 3000:3000 \
+  -v ./examples/config.json:/home/gateway/.config/mcp-gateway/config.json:ro \
+  mcp-gateway
+```
+
+**Endpoints:**
+
+| Endpoint | Description |
+|----------|-------------|
+| `GET /` | Gateway info and endpoints |
+| `GET /health` | Health check |
+| `/mcp` | MCP protocol endpoint |
+
+**Example:**
+
+```bash
+curl http://localhost:3000/
+# {"name":"MCP Gateway",...,"endpoints":{"mcp":"/mcp","health":"/health"}}
+
+curl http://localhost:3000/health
+# {"status":"ok"}
+```
+
+### Remote Server Configuration
+
+Remote servers are auto-detected based on the URL protocol:
+- `http://` or `https://` → Streamable HTTP (recommended)
+- `ws://` or `wss://` → WebSocket
+
+```json
+{
+  "gh-grep": {
+    "type": "remote",
+    "url": "https://mcp.grep.app"
+  },
+  "custom-websocket": {
+    "type": "remote",
+    "url": "wss://my-server.com/mcp"
+  }
+}
+```
+
+## Available Tools
+
+### `gateway.search`
+
+Search for tools across all connected servers.
+
+```typescript
+{
+  query: "kubernetes pods",
+  limit: 10,  // optional, max 50
+  filters: {
+    server: "kubernetes",  // optional, filter by server name
+  }
+}
+```
+
+Returns matching tools with relevance scores. Tools matching in name are boosted.
+
+### `gateway.describe`
+
+Get detailed information about a specific tool.
+
+```typescript
+{
+  id: "kubernetes::pods_list"  // format: serverKey::toolName
+}
+```
+
+Returns the full tool schema including inputSchema.
+
+### `gateway.invoke`
+
+Execute a tool synchronously and get immediate results.
+
+```typescript
+{
+  id: "kubernetes::pods_list",
+  args: { namespace: "default" },
+  timeoutMs: 30000  // optional, default 30 seconds
+}
+```
+
+### `gateway.invoke_async`
+
+Start an asynchronous tool execution. Returns a job ID for polling.
+
+```typescript
+{
+  id: "some-server::long-running-tool",
+  args: { ... },
+  priority: 10,  // optional, higher values run first
+  timeoutMs: 60000
+}
+```
+
+### `gateway.invoke_status`
+
+Check the status of an async job.
+
+```typescript
+{
+  jobId: "job_123456789_abc123"
+}
+```
+
+## Tool ID Format
+
+All gateway tools use the format `serverKey::toolName` to identify tools:
+
+```
+kubernetes::pods_list
+playwright::browser_navigate
+github::create_issue
+```
+
+The `serverKey` is the key name in your configuration file.
+
+## Architecture
+
+### Components
+
+- **MCPGateway class**: Main orchestrator
+- **Upstream connection manager**: Manages connections to MCP servers (stdio for local, HTTP/WebSocket for remote)
+- **Tool catalog**: In-memory index of all available tools with metadata
+- **Job queue**: Handles async tool invocations with priority ordering and concurrency limits (max 3 concurrent by default)
+- **Search engine**: MiniSearch with BM25 scoring and fuzzy matching
+
+### Search Algorithm
+
+The search uses [MiniSearch](https://github.com/lucaong/minisearch) with BM25 ranking:
+
+- **BM25 scoring**: Relevance algorithm
+- **Field boosting**: Name matches (3x), title matches (2x), description/server matches (1x)
+- **Fuzzy matching**: Handles typos with 0.2 threshold (e.g., "kubenetes" → finds "kubernetes")
+- **Prefix search**: Partial word matching (e.g., "pod" matches "pods_list")
+
+### Contributing
+
+```bash
+git clone https://github.com/eznix86/mcp-gateway.git
+cd mcp-gateway
+bun install
+
+# Run locally (stdio transport)
+bun run index.ts
+
+# Run with Docker (HTTP transport on port 3000)
+bun run docker:build && bun run docker:run
+```
+
+## License
+
+MIT License. See the [LICENSE](LICENSE).