@ushiradineth/veil 0.1.5 → 0.1.6

package/README.md

@@ -1,41 +1,20 @@
-# veil
+# Veil MCP
 
 Veil is a fast MCP server and CLI for local code retrieval. It indexes a repo and exposes focused tools for files, symbols, search, lookup, web research, URL fetch, and git context.
 
-## 2-minute setup
+## What It Is For
 
-Add Veil to your MCP client config:
-
-```json
-{
-  "mcpServers": {
-    "veil": {
-      "command": "npx",
-      "args": ["-y", "@ushiradineth/veil@latest", "server"]
-    }
-  }
-}
-```
+Veil is built for agents that need to move from prompt to implementation quickly.
 
-Then restart your MCP client.
+It gives the agent indexed access to files, symbols, and relevant code chunks, so it can retrieve precise context before writing code. This reduces broad file reads and repeated text scans, improves token efficiency, and shortens time to first meaningful code change.
 
-## MCP config snippets
+In practice, Veil acts as a local retrieval layer for coding agents: discover where code lives, resolve symbols, pull focused context, then execute edits.
 
-Claude Desktop (`~/Library/Application Support/Claude/claude_desktop_config.json`):
+## Get Started
 
-```json
-{
-  "mcpServers": {
-    "veil": {
-      "command": "npx",
-      "args": ["-y", "@ushiradineth/veil@latest", "server"],
-      "env": {}
-    }
-  }
-}
-```
+Requires Node.js 20 or later.
 
-Codex (`~/.config/codex/mcp.json`) and OpenCode (`~/.config/opencode/mcp.json`):
+Add Veil to your MCP client config:
 
 ```json
 {
@@ -48,115 +27,129 @@ Codex (`~/.config/codex/mcp.json`) and OpenCode (`~/.config/opencode/mcp.json`):
 }
 ```
 
-Optional Bun launcher:
+Install the Veil skill (optional, improves agent tool routing):
 
-```json
-{
-  "mcpServers": {
-    "veil": {
-      "command": "bunx",
-      "args": ["@ushiradineth/veil", "server"]
-    }
-  }
-}
+```bash
+npx -y skills add https://github.com/ushiradineth/veil/tree/main/docs --skill veil --list
 ```
 
-Local clone launcher:
+## MCP Tools
+
+Available Veil MCP tools:
+
+|     | Tool | Description |
+| --- | --- | --- |
+| - | `status` | Index status and staleness reasons |
+| - | `refresh` | Full or changed index refresh |
+| - | `files` | File path substring lookup |
+| - | `symbols` | Symbol name lookup |
+| - | `search` | Indexed code chunk search |
+| - | `lookup` | Intent-aware contextual retrieval with explainability |
+| - | `discover` | Combined status and focused retrieval in one call |
+| - | `web_search` | No-key web search (`google`, `duckduckgo`, `wikipedia`, `github`, `reddit`, `deepwiki`) |
+| - | `fetch_url` | Markdown-first URL content fetch |
+| - | `git_status` | Branch and workspace state |
+| - | `git_log` | Commit history lookup |
+| - | `git_diff` | Uncommitted or range diff lookup |
+| - | `git_show` | Commit details and optional patch |
+| - | `gh_lookup` | GitHub issues, PRs, checks, and repo context bootstrap via `gh` |
+| - | `diagnostics` | Cache and latency diagnostics |
+
+## CLI Examples
 
-```json
-{
-  "mcpServers": {
-    "veil": {
-      "command": "bun",
-      "args": ["run", "/path/to/veil/src/server.ts"]
-    }
-  }
-}
+```bash
+# status and refresh
+veil cli status --workspace .
+veil cli refresh --workspace . --mode changed
+
+# local index retrieval
+veil cli discover --workspace . --query "find build logic"
+veil cli lookup --workspace . --query "where is parseNdjson defined"
+
+# web and fetch
+veil cli web-search --query "typescript language server" --limit 5
+veil cli fetch-url --url https://example.com --format markdown
+
+# git and github context
+veil cli git-status --workspace .
+veil cli git-log --workspace . --limit 10
+veil cli git-diff --workspace .
+veil cli git-show --workspace . --rev HEAD
+veil cli gh-lookup --repo owner/repo --kind issues --query "is:open"
+
+# diagnostics
+veil cli diagnostics
 ```
 
-## Quick verification
+## MCP Client Configuration
 
-Package path:
+<details>
+  <summary>Codex</summary>
+  Follow the <a href="https://developers.openai.com/codex/mcp/#configure-with-the-cli">configure MCP guide</a>
+  using the standard config from above. You can also install Veil using the Codex CLI:
 
 ```bash
-npx -y @ushiradineth/veil@latest cli status
+codex mcp add veil -- npx -y @ushiradineth/veil@latest server
 ```
 
-Local clone path:
+</details>
 
-```bash
-node bin/veil.mjs cli status
-```
+<details>
+  <summary>Claude Code</summary>
 
-Build and query a workspace:
+Install via CLI:
 
 ```bash
-npx -y @ushiradineth/veil@latest cli refresh --workspace ~/nix-config --mode full
-npx -y @ushiradineth/veil@latest cli discover --workspace ~/nix-config --query "where is buildIndex defined"
+claude mcp add --scope user veil -- npx -y @ushiradineth/veil@latest server
 ```
 
-If you run these commands from inside a local `veil` clone, keep `@latest` in the package spec so npm does not resolve to the local workspace package.
+See the <a href="https://code.claude.com/docs/en/mcp">Claude Code MCP guide</a> for more details.
 
-## Agent skill install (`veil`)
+</details>
 
-Install and list from local path:
+<details>
+  <summary>OpenCode</summary>
 
-```bash
-npx -y skills add ./docs --skill veil --list
+Add the following configuration to your `opencode.json` file. If you do not have one, create it at `~/.config/opencode/opencode.json` (<a href="https://opencode.ai/docs/mcp-servers">guide</a>):
+
+```json
+{
+  "$schema": "https://opencode.ai/config.json",
+  "mcp": {
+    "veil": {
+      "type": "local",
+      "command": ["npx", "-y", "@ushiradineth/veil@latest", "server"]
+    }
+  }
+}
 ```
 
-Install and list from GitHub path:
+</details>
 
-```bash
-npx -y skills add https://github.com/ushiradineth/veil/tree/main/docs --skill veil --list
-```
+<details>
+  <summary>Cursor</summary>
 
-Note: this command reflects the current `main` branch contents on GitHub.
+Click to install:
 
-Optional agent targeting:
+[<img src="https://cursor.com/deeplink/mcp-install-dark.svg" alt="Install in Cursor">](https://cursor.com/en/install-mcp?name=veil&config=eyJjb21tYW5kIjoibnB4IC15IEB1c2hpcmFkaW5ldGgvdmVpbEBsYXRlc3Qgc2VydmVyIn0%3D)
 
-```bash
-npx -y skills add https://github.com/ushiradineth/veil/tree/main/docs --skill veil -a opencode
+Or install manually in `Cursor Settings` -> `MCP` -> `New MCP Server` with:
+
+```json
+{
+  "mcpServers": {
+    "veil": {
+      "command": "npx",
+      "args": ["-y", "@ushiradineth/veil@latest", "server"]
+    }
+  }
+}
 ```
 
-## Integration checklist
-
-- `veil` server starts in your MCP client
-- `status` returns index metadata
-- `discover` returns relevant repo hits
-- local `skills ... --list` shows `veil`
-- Routing guidance is loaded from `docs/SKILL.md`
-
-## MCP tools
-
-- `status`: index status and staleness reasons
-- `refresh`: full or changed index refresh
-- `files`: file path substring lookup
-- `symbols`: symbol name lookup
-- `search`: indexed code chunk search
-- `lookup`: intent-aware contextual retrieval with explainability
-- `discover`: combined status and focused retrieval in one call
-- `web_search`: no-key web search (google, duckduckgo, wikipedia, github, reddit, deepwiki)
-- `fetch_url`: markdown-first URL content fetch
-- `git_status`: branch and workspace state
-- `git_log`: commit history lookup
-- `git_diff`: uncommitted or range diff lookup
-- `git_show`: commit details and optional patch
-- `gh_lookup`: GitHub issues, PRs, and checks via `gh`
-- `diagnostics`: cache and latency diagnostics
-
-## Release workflow
-
-- Workflow: `.github/workflows/release.yml` (`workflow_dispatch`)
-- Inputs: `version_bump` (`patch|minor|major`) and `dry_run` (`true|false`)
-- Guardrails: release runs only from default branch and requires `package.json` version to match latest semver tag (`vX.Y.Z`) before bump
-- Outputs: updates `package.json` and `CHANGELOG.md`, tags `v<version>`, publishes npm package, and creates GitHub release
-- Release notes: generated via GitHub release notes config in `.github/release.yml` with changelog fallback so release pages are never empty
-- Required secret: `NPM_TOKEN` for npm publish (`GITHUB_TOKEN` is provided by Actions)
-
-## Links
-
-- Benchmark methodology and latest artifacts: `BENCHMARKS.md`
-- Agent routing policy: `AGENTS.md`
-- Reusable routing skill: `docs/SKILL.md`
-- License: `LICENSE`
+</details>
+
+<details>
+  <summary>Windsurf</summary>
+  Follow the <a href="https://docs.windsurf.com/windsurf/cascade/mcp#mcp-config-json">configure MCP guide</a>
+  using the standard config from above.
+</details>

package/bin/veil.mjs

@@ -1,21 +1,3 @@
 #!/usr/bin/env node
 
-import { spawnSync } from "node:child_process";
-import { fileURLToPath } from "node:url";
-import { dirname, resolve } from "node:path";
-
-const args = process.argv.slice(2);
-const root = resolve(dirname(fileURLToPath(import.meta.url)), "..");
-const entry = resolve(root, "dist", "bin.js");
-
-const run = spawnSync(process.execPath, [entry, ...args], {
-  stdio: "inherit",
-  env: process.env,
-});
-
-if (run.error) {
-  process.stderr.write(`Failed to launch veil entrypoint: ${String(run.error.message ?? run.error)}\n`);
-  process.exit(1);
-}
-
-process.exit(run.status ?? 1);
+import("../dist/bin.js");