mcp-compress-router 1.5.2 → 1.5.4

package/README.md

@@ -20,6 +20,9 @@
 - [The Solution](#the-solution)
 - [Prerequisites](#prerequisites)
 - [Quick Start](#quick-start)
+    - [1. Connect your coding agent](#1-connect-your-coding-agent)
+    - [2. Add downstream MCP servers](#2-add-downstream-mcp-servers)
+    - [3. Verify and use](#3-verify-and-use)
 - [Configuration](#configuration)
     - [Config File Location](#config-file-location)
     - [Adding Downstream Servers](#adding-downstream-servers)
@@ -29,17 +32,12 @@
     - [Inspecting Tools](#inspecting-tools)
     - [OAuth](#oauth)
         - [Redirect URL](#redirect-url)
-        - [GitHub MCP (special case)](#github-mcp-special-case)
-        - [Figma MCP (special case)](#figma-mcp-special-case)
+        - [GitHub MCP with OAuth (special case)](#github-mcp-with-oauth-special-case)
+        - [Figma MCP with OAuth (special case)](#figma-mcp-with-oauth-special-case)
     - [Custom Headers](#custom-headers)
     - [Secrets and Variable Expansion](#secrets-and-variable-expansion)
-- [Connecting Coding Agents](#connecting-coding-agents)
-    - [Opencode](#opencode)
-    - [Claude Code](#claude-code)
-    - [Codex](#codex)
-    - [GitHub Copilot](#github-copilot)
 - [How It Works](#how-it-works)
-- [Aknowledgements](#acknowledgements)
+- [Acknowledgements](#acknowledgements)
 
 ## The Problem
 
@@ -95,17 +93,99 @@ have, the more you save.
 
 The router is published on npm as
 [`mcp-compress-router`](https://www.npmjs.com/package/mcp-compress-router).
-You do not need to install it — just run it with `npx`:
+You do not need to install it — just run it with `npx`.
+
+Setup is two steps: first connect your coding agent to the router, then
+add the MCP servers you want to compress behind it.
+
+### 1. Connect your coding agent
+
+Point your agent at the router the same way you would point it at any
+other MCP server. The router reads its server list from a
+[user-wide config file](#config-file-location) by default, so register
+it at the **user** scope (or your agent's equivalent) — every project
+then gets the same compressed catalog with no per-project setup.
+
+- **Claude Code** — see the
+  [Claude Code MCP docs](https://code.claude.com/docs/en/mcp).
+  Add it at `user` scope so it applies everywhere (Claude Code also
+  supports `local` for a single private project and `project` for a
+  shareable `.mcp.json`):
+
+  ```sh
+  claude mcp add mcp-compress-router --scope user -- npx -y mcp-compress-router@latest
+  ```
+
+- **Opencode** — see the
+  [opencode MCP servers docs](https://opencode.ai/docs/mcp-servers/).
+
+  ```sh
+  opencode mcp add mcp-compress-router -- npx -y mcp-compress-router@latest
+  ```
+
+- **Codex** — see the
+  [Codex MCP docs](https://developers.openai.com/codex/mcp).
+
+  ```sh
+  codex mcp add mcp-compress-router -- npx -y mcp-compress-router@latest
+  ```
+
+- **GitHub Copilot (VS Code)** — see the
+  [VS Code MCP docs](https://code.visualstudio.com/docs/agent-customization/mcp-servers).
+  Open the Command Palette (`Cmd+Shift+P`) →
+  `MCP: Open User Configuration` and add the server block under
+  `mcp.servers` (project-level `.vscode/mcp.json` is also supported
+  and merged with the user-level settings, project taking precedence):
+
+  ```json
+  {
+    "servers": {
+      "mcp-compress-router": {
+        "command": "npx",
+        "args": ["-y", "mcp-compress-router@latest"]
+      }
+    }
+  }
+  ```
+
+### 2. Add downstream MCP servers
+
+Use the `add` command to register each MCP server you want to compress.
+The router writes them to its [config file](#config-file-location) and
+they appear in the catalog the next time the router starts.
 
 ```bash
 npx mcp-compress-router@latest add playwright -- npx -y @playwright/mcp
 ```
 
-This registers a downstream MCP server named `playwright` and writes it
-to your [config file](#config-file-location). Repeat for every MCP server
-you want to compress.
+Add a description so the LLM can pick the right server, and use
+environment variables to keep secrets out of the config:
+
+```bash
+npx mcp-compress-router@latest add github \
+  --description "GitHub API tools" \
+  -e GITHUB_PERSONAL_TOKEN=ghp_xxx \
+  -- npx -y @modelcontextprotocol/server-github
+```
 
-Then point your [coding agent](#connecting-coding-agents) at the router:
+Repeat for every MCP server you want to compress. See
+[Adding Downstream Servers](#adding-downstream-servers) for HTTP
+servers, custom headers, OAuth, and other options.
+
+### 3. Verify and use
+
+Check that everything is wired up:
+
+```bash
+npx mcp-compress-router@latest list
+```
+
+Then start a new session in your coding agent. The agent picks up the
+router's two tools — `get_tool_schema` and `invoke_tool` — and uses
+them to discover and call every server you added, without the agent
+ever seeing the raw tool listings of each downstream server.
+
+Under the hood your agent spawns the router as a child process with:
 
 ```bash
 npx mcp-compress-router@latest
@@ -113,7 +193,8 @@ npx mcp-compress-router@latest
 
 When started without a subcommand, the router runs the MCP server over
 stdio and exposes exactly two tools (`get_tool_schema`,
-`invoke_tool`) to the agent.
+`invoke_tool`) to the agent. You normally do not run this yourself —
+your agent spawns the router automatically.
 
 ## Configuration
 
@@ -338,6 +419,16 @@ A good rule of thumb:
 - Use `low` sparingly — only when full descriptions must be visible
   without a `get_tool_schema` call, since it costs the most tokens.
 
+> **Note for Claude Code:** Claude Code truncates any single tool
+> description at 2000 characters. The router renders the entire
+> compressed catalog into the `get_tool_schema` description that the
+> agent receives on every turn, so with several downstream servers or
+> many tools per server the `high`, `medium`, or `low` listings can
+> exceed that limit and get truncated — breaking routing. When using
+> Claude Code, set `compressionLevel: "max"` on your servers (or pass
+> `--compression-level max` to `add`) so each server's tool listing
+> collapses to a comma-separated single line.
+
 ### Inspecting Tools
 
 To see exactly which tools a server advertises — and which are
@@ -640,52 +731,6 @@ MY_SERVER_TOKEN=secret-token
 
 Shell environment variables always take precedence over `.env` values.
 
-## Connecting Coding Agents
-
-Once your downstream servers are configured, connect your agent to the
-router the same way you would connect any other MCP server — by
-pointing it at `npx mcp-compress-router@latest`. The examples below assume the
-default [config location](#config-file-location); pass `-c <path>` if
-you use a custom one.
-
-### Opencode
-
-```sh
-opencode mcp add mcp-compress-router -- npx -y mcp-compress-router@latest
-```
-
-### Claude Code
-
-```sh
-claude mcp add mcp-compress-router -- npx -y mcp-compress-router@latest
-```
-
-### Codex
-
-```sh
-codex mcp add mcp-compress-router -- npx -y mcp-compress-router@latest
-```
-
-### GitHub Copilot (VS Code)
-
-Add this to `.vscode/mcp.json` in your workspace (project-level, applies
-only to that workspace), or to your **user-level** MCP settings which
-apply across every workspace: open the Command Palette (`Cmd+Shift+P`) →
-`MCP: Open User Configuration` and add the same `servers`
-block under the `mcp` key. Project-level and user-level entries are
-merged, with project-level taking precedence.
-
-```json
-{
-  "servers": {
-    "mcp-compress-router": {
-      "command": "npx",
-      "args": ["-y", "mcp-compress-router@latest"]
-    }
-  }
-}
-```
-
 ## How It Works
 
 Once connected, the agent sees exactly **two tools**:

package/build/cli/add-command.js

@@ -17,7 +17,7 @@ function validateToolListPatterns(field, patterns) {
         }
         catch (err) {
             const reason = err instanceof Error ? err.message : String(err);
-            throw new Error(`Invalid "${field}" pattern "${pattern}": ${reason}`);
+            throw new Error(`Invalid "${field}" pattern "${pattern}": ${reason}`, { cause: err });
         }
     }
 }

package/build/cli/register-commands.js

@@ -3,7 +3,7 @@ import { handleAdd, handleRemove, handleGet, handleList, handleLogin, handleLogo
 import { runRouter } from './router-runner.js';
 /**
  * Collects repeated `--header "K: V"` flags into a headers record.
- * @internal — Exported for tests only; not part of the public module API.
+ * @internal Exported for tests only; not part of the public module API.
  */
 export function collectHeaders(value, previous) {
     const colonIdx = value.indexOf(':');
@@ -16,7 +16,7 @@ export function collectHeaders(value, previous) {
 }
 /**
  * Collects repeated `-e KEY=value` flags into an env record.
- * @internal — Exported for tests only; not part of the public module API.
+ * @internal Exported for tests only; not part of the public module API.
  */
 export function collectEnv(value, previous) {
     const eqIdx = value.indexOf('=');
@@ -29,7 +29,7 @@ export function collectEnv(value, previous) {
 }
 /**
  * Collects repeated `--flag <value>` flags into an ordered string array.
- * @internal — Exported for tests only; not part of the public module API.
+ * @internal Exported for tests only; not part of the public module API.
  */
 export function collectStringArray(value, previous) {
     return [...previous, value];
@@ -38,7 +38,7 @@ export function collectStringArray(value, previous) {
  * Coerces a `--port` flag value into an integer. Throws on non-numeric
  * values so the user gets a clear error before any network activity.
  * Range validation is deferred to the command handlers.
- * @internal — Exported for tests only; not part of the public module API.
+ * @internal Exported for tests only; not part of the public module API.
  */
 export function parsePort(value) {
     const port = Number(value);

package/build/services/config.js

@@ -297,7 +297,9 @@ function validateToolList(name, field, value) {
         }
         catch (err) {
             const reason = err instanceof Error ? err.message : String(err);
-            throw new Error(`Server "${name}" has invalid "${field}" pattern "${entry}": ${reason}`);
+            throw new Error(`Server "${name}" has invalid "${field}" pattern "${entry}": ${reason}`, {
+                cause: err,
+            });
         }
         patterns.push(entry);
     }

package/build/services/discovery.js

@@ -86,7 +86,7 @@ export async function discoverSingleServer(server, logger, getAuthProvider) {
             type: server.type,
             error: message,
         });
-        throw new Error(`Failed to connect to server "${server.name}": ${message}`);
+        throw new Error(`Failed to connect to server "${server.name}": ${message}`, { cause: err });
     }
     finally {
         await client.close().catch(() => { });

package/build/utils/validate-glob.js

@@ -16,6 +16,6 @@ export function validateGlobPattern(pattern) {
     }
     catch (err) {
         const reason = err instanceof Error ? err.message : String(err);
-        throw new Error(`Invalid glob pattern "${pattern}": ${reason}`);
+        throw new Error(`Invalid glob pattern "${pattern}": ${reason}`, { cause: err });
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mcp-compress-router",
-  "version": "1.5.2",
+  "version": "1.5.4",
   "description": "Compress all connected MCP servers into a single router MCP to save tokens",
   "license": "MIT",
   "type": "module",
@@ -25,17 +25,17 @@
     "url": "https://github.com/ameshkov/mcp-compress-router/issues"
   },
   "scripts": {
-    "build": "tsc && node -e \"require('fs').chmodSync('build/index.js', '755')\"",
-    "typecheck": "tsc && tsc --project tsconfig.test.json",
+    "build": "tsc -p tsconfig.app.json && node -e \"require('fs').chmodSync('build/index.js', '755')\"",
+    "typecheck": "tsc -p tsconfig.app.json --noEmit && tsc -p tsconfig.test.json",
     "test": "vitest run",
     "test:watch": "vitest",
     "clean": "rm -rf node_modules build",
     "format:check": "prettier --check --no-error-on-unmatched-pattern --cache . && markdownlint-cli2 .",
     "format:fix": "prettier --write --no-error-on-unmatched-pattern --cache . && markdownlint-cli2 --fix .",
-    "lint": "eslint src && pnpm knip",
-    "lint:fix": "eslint src --fix",
+    "lint": "oxlint src && pnpm knip",
+    "lint:fix": "oxlint src --fix",
     "knip": "knip --production",
-    "check": "pnpm run format:check && pnpm run lint && pnpm run typecheck && pnpm run test",
+    "check": "pnpm run format:check && pnpm run lint && pnpm run typecheck && pnpm run build && pnpm run test",
     "prepare": "husky || true"
   },
   "files": [
@@ -51,25 +51,23 @@
   ],
   "author": "Andrey Meshkov <am@adguard.com>",
   "devDependencies": {
-    "@eslint/js": "9.16.0",
-    "@types/node": "24.13.2",
+    "@types/node": "26.1.2",
     "@types/picomatch": "4.0.3",
-    "eslint": "9.16.0",
     "husky": "9.1.7",
-    "knip": "6.6.2",
-    "markdownlint-cli2": "0.22.0",
-    "prettier": "3.7.4",
-    "tsx": "4.20.3",
-    "typescript": "5.9.3",
-    "typescript-eslint": "8.57.0",
-    "vitest": "3.2.4"
+    "knip": "6.29.0",
+    "markdownlint-cli2": "0.23.2",
+    "oxlint": "1.76.0",
+    "prettier": "3.9.6",
+    "tsx": "4.23.1",
+    "typescript": "7.0.2",
+    "vitest": "4.1.10"
   },
   "dependencies": {
-    "@modelcontextprotocol/sdk": "1.24.3",
-    "commander": "14.0.2",
+    "@modelcontextprotocol/sdk": "1.30.0",
+    "commander": "15.0.0",
     "dotenv": "17.4.2",
     "jsonc-parser": "3.3.1",
-    "picomatch": "4.0.4",
-    "zod": "3.25.76"
+    "picomatch": "4.0.5",
+    "zod": "4.4.3"
   }
 }