aidex-mcp 1.4.1 → 1.5.0

package/CHANGELOG.md

@@ -2,6 +2,25 @@
 
 All notable changes to AiDex will be documented in this file.
 
+## [1.5.0] - 2026-01-31
+
+### Added
+- **`aidex setup`**: Auto-register AiDex as MCP server in all detected AI clients
+  - Supports: Claude Code, Claude Desktop, Cursor, Windsurf
+  - Cross-platform: Windows, macOS, Linux
+- **`aidex unsetup`**: Remove AiDex registration from all clients
+- **Postinstall hint**: Shows `Run "aidex setup"` after npm install
+
+## [1.4.2] - 2026-01-31
+
+### Added
+- **npm package**: Published as `aidex-mcp` on npm (`npm install -g aidex-mcp`)
+- **Dual CLI commands**: Both `aidex` and `aidex-mcp` work as command names
+- **npm-publish.bat**: Script for easy npm publishing
+
+### Changed
+- README updated with npm install instructions
+
 ## [1.4.1] - 2026-01-31
 
 ### Fixed

package/README.md

@@ -1,5 +1,6 @@
 # AiDex
 
+[![npm version](https://img.shields.io/npm/v/aidex-mcp.svg)](https://www.npmjs.com/package/aidex-mcp)
 [![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
 [![Node.js 18+](https://img.shields.io/badge/Node.js-18%2B-brightgreen.svg)](https://nodejs.org/)
 [![MCP Server](https://img.shields.io/badge/MCP-Server-blue.svg)](https://modelcontextprotocol.io/)
@@ -105,15 +106,16 @@ The index lives in `.aidex/index.db` (SQLite) - fast, portable, no external depe
 
 ## Quick Start
 
-### 1. Install
+### 1. Install & Register
 
 ```bash
-git clone https://github.com/CSCSoftware/AiDex.git
-cd AiDex
-npm install && npm run build
+npm install -g aidex-mcp
+aidex setup
 ```
 
-### 2. Register with your AI assistant
+`aidex setup` automatically detects and registers AiDex with your installed AI clients (Claude Code, Claude Desktop, Cursor, Windsurf). To unregister: `aidex unsetup`.
+
+### 2. Or register manually with your AI assistant
 
 **For Claude Code** (`~/.claude/settings.json` or `~/.claude.json`):
 ```json
@@ -121,8 +123,7 @@ npm install && npm run build
   "mcpServers": {
     "aidex": {
       "type": "stdio",
-      "command": "node",
-      "args": ["/path/to/AiDex/build/index.js"],
+      "command": "aidex",
       "env": {}
     }
   }
@@ -134,13 +135,14 @@ npm install && npm run build
 {
   "mcpServers": {
     "aidex": {
-      "command": "node",
-      "args": ["/path/to/AiDex/build/index.js"]
+      "command": "aidex"
     }
   }
 }
 ```
 
+> **Note:** Both `aidex` and `aidex-mcp` work as command names.
+
 > **Important:** The server name in your config determines the MCP tool prefix. Use `"aidex"` as shown above — this gives you tool names like `aidex_query`, `aidex_signature`, etc. Using a different name (e.g., `"codegraph"`) would change the prefix accordingly.
 
 **For other MCP clients**: See your client's documentation for MCP server configuration.
@@ -263,10 +265,12 @@ Close with `aidex_viewer({ path: ".", action: "close" })`
 ## CLI Usage
 
 ```bash
-node build/index.js scan Q:/develop   # Find all indexed projects
-node build/index.js init ./myproject  # Index a project from command line
+aidex scan Q:/develop       # Find all indexed projects
+aidex init ./myproject      # Index a project from command line
 ```
 
+> `aidex-mcp` works as an alias for `aidex`.
+
 ## Performance
 
 | Project | Files | Items | Index Time | Query Time |

package/build/commands/setup.d.ts

@@ -0,0 +1,8 @@
+/**
+ * AiDex Setup - Auto-register as MCP server in AI clients
+ *
+ * Supports: Claude Code, Claude Desktop, Cursor, Windsurf
+ */
+export declare function setupMcpClients(): void;
+export declare function unsetupMcpClients(): void;
+//# sourceMappingURL=setup.d.ts.map

package/build/commands/setup.js

@@ -0,0 +1,161 @@
+/**
+ * AiDex Setup - Auto-register as MCP server in AI clients
+ *
+ * Supports: Claude Code, Claude Desktop, Cursor, Windsurf
+ */
+import { existsSync, readFileSync, writeFileSync } from 'fs';
+import { join } from 'path';
+import { homedir, platform } from 'os';
+// ============================================================
+// MCP Server Entry
+// ============================================================
+const AIDEX_MCP_ENTRY = {
+    command: 'aidex',
+    args: []
+};
+// ============================================================
+// Client Detection
+// ============================================================
+function getClients() {
+    const home = homedir();
+    const plat = platform();
+    const clients = [];
+    // Claude Code
+    clients.push({
+        name: 'Claude Code',
+        configPath: join(home, '.claude', 'settings.json')
+    });
+    // Claude Desktop
+    if (plat === 'win32') {
+        const appData = process.env.APPDATA || join(home, 'AppData', 'Roaming');
+        clients.push({
+            name: 'Claude Desktop',
+            configPath: join(appData, 'Claude', 'claude_desktop_config.json')
+        });
+    }
+    else if (plat === 'darwin') {
+        clients.push({
+            name: 'Claude Desktop',
+            configPath: join(home, 'Library', 'Application Support', 'Claude', 'claude_desktop_config.json')
+        });
+    }
+    else {
+        clients.push({
+            name: 'Claude Desktop',
+            configPath: join(home, '.config', 'Claude', 'claude_desktop_config.json')
+        });
+    }
+    // Cursor
+    clients.push({
+        name: 'Cursor',
+        configPath: join(home, '.cursor', 'mcp.json')
+    });
+    // Windsurf
+    clients.push({
+        name: 'Windsurf',
+        configPath: join(home, '.codeium', 'windsurf', 'mcp_config.json')
+    });
+    return clients;
+}
+// ============================================================
+// Config Read/Write
+// ============================================================
+function readJsonConfig(filePath) {
+    try {
+        const content = readFileSync(filePath, 'utf8');
+        return { success: true, data: JSON.parse(content) };
+    }
+    catch (err) {
+        if (err.code === 'ENOENT') {
+            return { success: false, error: 'not found' };
+        }
+        if (err instanceof SyntaxError) {
+            return { success: false, error: `invalid JSON: ${err.message}` };
+        }
+        return { success: false, error: String(err) };
+    }
+}
+function writeJsonConfig(filePath, data) {
+    try {
+        const content = JSON.stringify(data, null, 2) + '\n';
+        writeFileSync(filePath, content, 'utf8');
+        return { success: true };
+    }
+    catch (err) {
+        return { success: false, error: String(err) };
+    }
+}
+// ============================================================
+// Setup / Unsetup
+// ============================================================
+export function setupMcpClients() {
+    const clients = getClients();
+    const results = [];
+    let registered = 0;
+    console.log('\nAiDex MCP Server Registration');
+    console.log('==============================\n');
+    for (const client of clients) {
+        if (!existsSync(client.configPath)) {
+            results.push({ client: client.name, status: 'skipped', configPath: client.configPath });
+            console.log(`  - ${client.name} (not installed)`);
+            continue;
+        }
+        const config = readJsonConfig(client.configPath);
+        if (!config.success || !config.data) {
+            results.push({ client: client.name, status: 'error', configPath: client.configPath, message: config.error });
+            console.log(`  ✗ ${client.name} (${config.error})`);
+            continue;
+        }
+        const data = config.data;
+        if (!data.mcpServers || typeof data.mcpServers !== 'object') {
+            data.mcpServers = {};
+        }
+        data.mcpServers.aidex = { ...AIDEX_MCP_ENTRY };
+        const writeResult = writeJsonConfig(client.configPath, data);
+        if (!writeResult.success) {
+            results.push({ client: client.name, status: 'error', configPath: client.configPath, message: writeResult.error });
+            console.log(`  ✗ ${client.name} (${writeResult.error})`);
+            continue;
+        }
+        registered++;
+        results.push({ client: client.name, status: 'registered', configPath: client.configPath });
+        console.log(`  ✓ ${client.name} (${client.configPath})`);
+    }
+    console.log(`\nRegistered AiDex with ${registered} client(s).\n`);
+    if (registered > 0) {
+        console.log('Restart your AI client(s) to activate AiDex.\n');
+    }
+}
+export function unsetupMcpClients() {
+    const clients = getClients();
+    let removed = 0;
+    console.log('\nAiDex MCP Server Unregistration');
+    console.log('================================\n');
+    for (const client of clients) {
+        if (!existsSync(client.configPath)) {
+            console.log(`  - ${client.name} (not installed)`);
+            continue;
+        }
+        const config = readJsonConfig(client.configPath);
+        if (!config.success || !config.data) {
+            console.log(`  ✗ ${client.name} (${config.error})`);
+            continue;
+        }
+        const data = config.data;
+        const servers = data.mcpServers;
+        if (!servers || !servers.aidex) {
+            console.log(`  - ${client.name} (not registered)`);
+            continue;
+        }
+        delete servers.aidex;
+        const writeResult = writeJsonConfig(client.configPath, data);
+        if (!writeResult.success) {
+            console.log(`  ✗ ${client.name} (${writeResult.error})`);
+            continue;
+        }
+        removed++;
+        console.log(`  ✓ Removed from ${client.name}`);
+    }
+    console.log(`\nUnregistered AiDex from ${removed} client(s).\n`);
+}
+//# sourceMappingURL=setup.js.map

package/build/index.js

@@ -11,6 +11,7 @@
  */
 import { createServer } from './server/mcp-server.js';
 import { scan, init } from './commands/index.js';
+import { setupMcpClients, unsetupMcpClients } from './commands/setup.js';
 import { PRODUCT_NAME, PRODUCT_NAME_LOWER } from './constants.js';
 async function main() {
     const args = process.argv.slice(2);
@@ -63,6 +64,16 @@ async function main() {
         console.log(`  Time: ${result.durationMs}ms`);
         return;
     }
+    // CLI mode: setup
+    if (args[0] === 'setup') {
+        setupMcpClients();
+        return;
+    }
+    // CLI mode: unsetup
+    if (args[0] === 'unsetup') {
+        unsetupMcpClients();
+        return;
+    }
     // Default: Start MCP server
     const server = createServer();
     await server.start();

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "aidex-mcp",
-  "version": "1.4.1",
+  "version": "1.5.0",
   "description": "MCP Server providing persistent code indexing for Claude Code",
   "main": "build/index.js",
   "bin": {
-    "aidex": "build/index.js"
+    "aidex": "build/index.js",
+    "aidex-mcp": "build/index.js"
   },
   "type": "module",
   "scripts": {
@@ -15,6 +16,7 @@
     "dev": "tsc && node build/index.js",
     "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
     "clean": "rimraf build",
+    "postinstall": "node scripts/postinstall.mjs",
     "prepublishOnly": "npm run build"
   },
   "keywords": [

package/scripts/postinstall.mjs

@@ -0,0 +1,2 @@
+// Postinstall hint - shown after npm install -g aidex-mcp
+console.log('\n  AiDex installed! Run "aidex setup" to register with your AI clients.\n');