mcp-squared 0.1.0 → 0.2.0

package/README.md

@@ -1,23 +1,199 @@
 # MCP²: Mercury Control Plane for MCP
 
-MCP² (Mercury Control Plane) is a local-first meta-server and proxy for the Model Context Protocol (MCP). It addresses the problem of tool context bloat and schema token overhead by enabling dynamic, progressive disclosure of tools to LLMs. Instead of flooding the model context with every available tool schema, MCP² exposes a stable, minimal surface area for tool discovery and execution.
+MCP² (Mercury Control Plane) is a local-first meta-server and proxy for the Model Context Protocol (MCP). It addresses tool context bloat by enabling dynamic, progressive disclosure of tools to LLMs. Instead of flooding the model context with every available tool schema, MCP² exposes a stable, minimal surface area for tool discovery and execution.
 
 ## Status
-**Inception / Pre-alpha**
+**Alpha (v0.1.x)** - Core functionality is implemented and tested; CLI and config details may evolve.
 
-## High-Level Approach
-MCP² acts as an intelligent middleware between your MCP clients (IDEs, agents) and upstream MCP servers. It provides:
-- `find_tools`: A semantic search interface to locate relevant capabilities.
-- `describe_tools`: On-demand retrieval of full schemas for selected tools.
-- `execute`: A passthrough execution layer with optional result caching and summarization.
+## Install & Run
+
+MCP² is published on npm as `mcp-squared`. The CLI runs on Bun (even when installed via npm), so you'll need Bun installed on your machine.
+
+### Prerequisite: Bun
+
+Install Bun (>= 1.0.0): https://bun.sh
+
+### Run without installing (recommended)
+
+```bash
+bunx mcp-squared --help
+bunx mcp-squared
+```
+
+### Run via npm / npx
+
+```bash
+npx mcp-squared --help
+npm exec --yes mcp-squared -- --help
+```
+
+### Install globally
+
+```bash
+npm i -g mcp-squared
+mcp-squared --help
+
+# or
+bun add -g mcp-squared
+mcp-squared --help
+```
+
+### Run from source
+
+```bash
+# Clone the repository
+git clone https://github.com/aditzel/mcp-squared
+cd mcp-squared
+
+# Install dependencies
+bun install
+
+# Run in development mode
+bun run dev
+
+# Build for production
+bun run build
+
+# Run tests
+bun test
+```
+
+### Standalone Executable (Experimental)
+
+Build a single-file executable with Bun:
+
+```bash
+bun run build:compile
+```
+
+Run the compile validation matrix (target support, size check, standalone smoke test, embeddings probe):
+
+```bash
+bun run build:compile:matrix
+```
+
+Current findings and known blockers are tracked in `docs/STANDALONE-COMPILE.md`.
+
+## CLI Commands (Common)
+
+```bash
+mcp-squared                 # Auto: daemon (TTY) or proxy (piped stdio)
+mcp-squared --stdio         # Start MCP server (stdio mode)
+mcp-squared daemon          # Start shared daemon (multi-client backend)
+mcp-squared proxy           # Start stdio proxy to the shared daemon
+mcp-squared config          # Launch configuration TUI
+mcp-squared test [upstream] # Test upstream server connections
+mcp-squared auth <upstream> # OAuth auth for SSE/HTTP upstreams
+mcp-squared import          # Import MCP configs from other tools
+mcp-squared install         # Install MCP² into other MCP clients
+mcp-squared monitor         # Launch server monitor TUI
+mcp-squared --help          # Full command reference
+```
+
+## Shared Daemon Mode (Optional)
+
+Shared daemon mode keeps a single MCP² backend alive and lets multiple stdio clients connect through lightweight proxies. This reduces duplicated upstream connections and indexing work when many tools run in parallel.
+
+Auto mode chooses `daemon` when running in a TTY and `proxy` when stdin/stdout are piped (as MCP clients do).
+
+```bash
+mcp-squared daemon          # Start the shared backend
+mcp-squared proxy           # Run a stdio proxy that connects to the daemon
+```
+
+When installing into supported clients, you can register the proxy automatically:
+
+```bash
+mcp-squared install --proxy
+mcp-squared install --stdio
+```
+
+## Configuration
+
+Config discovery order:
+1. `MCP_SQUARED_CONFIG` environment variable
+2. Project-local `mcp-squared.toml` or `.mcp-squared/config.toml`
+3. User-level `~/.config/mcp-squared/config.toml` (or `%APPDATA%/mcp-squared/config.toml` on Windows)
+
+Minimal example:
+
+```toml
+schemaVersion = 1
+
+[upstreams.local]
+transport = "stdio"
+[upstreams.local.stdio]
+command = "mcp-server-local"
+args = []
+
+[upstreams.remote]
+transport = "sse"
+[upstreams.remote.sse]
+url = "https://example.com/mcp"
+auth = true
+```
+
+Security policies (allow/block/confirm) live under `security.tools`. Confirmation flows return a short-lived token that must be provided to `execute` to proceed. OAuth tokens for SSE upstreams are stored under `~/.config/mcp-squared/tokens/<upstream>.json`.
+
+## Tool API (Meta-Tools)
+
+MCP² exposes these tools to MCP clients:
+- `find_tools` - Search tools across upstream servers
+- `describe_tools` - Fetch full JSON schemas for selected tools
+- `execute` - Call an upstream tool with policy enforcement
+- `list_namespaces` - List upstream namespaces (optionally with tool names)
+- `clear_selection_cache` - Reset co-occurrence based suggestions
+
+## Search Modes
+
+`find_tools` supports three search modes:
+- `fast` (default): SQLite FTS5 full-text search
+- `semantic`: Embedding similarity search (falls back to `fast` if embeddings are missing)
+- `hybrid`: FTS5 + embedding rerank (falls back to `fast` if embeddings are missing)
+
+> **Note:** Semantic and hybrid modes load a local embedding model (BGE-small via Transformers.js/WASM). First load downloads ~33MB and adds ~294MB RSS. These modes are optional - `fast` mode (default) has no such overhead.
+
+Embeddings are generated locally using Transformers.js (BGE-small). They are optional and can be generated programmatically via the retriever API.
+
+## Supported MCP Clients (Import/Install)
+
+MCP² can import or install MCP server configs for:
+`claude-code`, `claude-desktop`, `cursor`, `windsurf`, `vscode`, `cline`, `roo-code`, `kilo-code`, `gemini-cli`, `zed`, `jetbrains`, `factory`, `opencode`, `qwen-code`, `trae`, `antigravity`, `warp` (import via explicit path), and `codex`.
+
+## Key Features
+- Multi-upstream support (stdio + SSE/HTTP)
+- OAuth 2.0 dynamic client registration for SSE upstreams
+- Hybrid search with optional local embeddings (FTS5 + Transformers.js)
+- Detail levels (L0/L1/L2) for progressive schema disclosure
+- Selection caching with co-occurrence suggestions
+- Background index refresh with change detection
+- Security policies (allow/block/confirm) with confirmation tokens
+- Local-first architecture (SQLite index)
+- TUI interfaces for configuration and monitoring
 
 ## Non-Goals
 - Not a hosted SaaS platform (local-first).
 - Not a replacement for MCP clients (it serves them).
 - Not shipping language runtimes or SDKs at this stage.
 
+## Architecture
+
+MCP² is built with Bun and TypeScript, leveraging:
+- @modelcontextprotocol/sdk for MCP communication
+- @huggingface/transformers for embeddings generation
+- @opentui/core for the terminal user interface
+- Zod for validation
+
+See `docs/ARCHITECTURE.md` for a full architecture breakdown.
+
 ## Contributing
-We welcome contributions! Please see [CONTRIBUTING.md](.github/CONTRIBUTING.md) for details on how to get started.
+
+We welcome contributions! Please see `.github/CONTRIBUTING.md` for details on how to get started.
+
+## Releasing
+
+Maintainers can follow `docs/RELEASING.md` for the npm release checklist.
 
 ## License
+
 Apache-2.0