@ngao/search 1.0.0-alpha.1 → 1.0.0-alpha.10

package/dist-bundled/main.js

@@ -1,3 +1,4 @@
+#!/usr/bin/env node
 /******/ (() => { // webpackBootstrap
 /******/ 	var __webpack_modules__ = ({
 
@@ -20113,7 +20114,7 @@ function _stringFormat(Class, format, fnOrRegex, _params = {}) {
  * Used by the MCP SDK server to validate tool inputs
  */
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.toolMetadata = exports.toolSchemas = exports.ListIndexedDirsInputSchema = exports.GetReindexStatusInputSchema = exports.StartReindexInputSchema = exports.GetSearchHistoryInputSchema = exports.GetFileStatisticsInputSchema = exports.GetIndexInfoInputSchema = exports.GetStatsInputSchema = exports.IndexInputSchema = exports.SearchInputSchema = void 0;
+exports.toolMetadata = exports.toolSchemas = exports.NGAO_DOCUMENTATION = exports.GetDocumentationInputSchema = exports.ListIndexedDirsInputSchema = exports.GetReindexStatusInputSchema = exports.StartReindexInputSchema = exports.GetSearchHistoryInputSchema = exports.GetFileStatisticsInputSchema = exports.GetIndexInfoInputSchema = exports.GetStatsInputSchema = exports.IndexInputSchema = exports.SearchInputSchema = void 0;
 const zod_1 = __webpack_require__(7552);
 /**
  * Search tool input schema
@@ -20178,6 +20179,112 @@ exports.GetReindexStatusInputSchema = zod_1.z.object({
  * List indexed dirs tool input schema (no parameters)
  */
 exports.ListIndexedDirsInputSchema = zod_1.z.object({});
+/**
+ * Get documentation tool input schema (no parameters)
+ */
+exports.GetDocumentationInputSchema = zod_1.z.object({});
+/**
+ * NGAO Search Documentation
+ */
+exports.NGAO_DOCUMENTATION = `
+# NGAO Search - MCP Server Documentation
+
+## Overview
+NGAO Search is a Model Context Protocol (MCP) server that provides Claude with the ability to search and understand your codebase.
+
+## Available Tools
+
+### 1. search
+Search through indexed code and documentation.
+- **query** (required): Search query (e.g., "authentication handler", "database connection")
+- **maxResults** (optional): Maximum results (default: 50)
+- **sessionId** (optional): Session ID for tracking search history
+
+Example: Search for "user authentication" in your codebase
+
+### 2. index
+Index a directory for searching.
+- **dirPath** (required): Directory path to index
+
+Example: Index your project directory to make it searchable
+
+### 3. get_stats
+Get indexing statistics about the current index.
+
+### 4. get_index_info
+Get detailed information about the index including file breakdown by language and type.
+
+### 5. get_file_statistics
+Get per-file statistics.
+- **filePath** (optional): Specific file path for detailed stats
+
+### 6. list_indexed_dirs
+List all directories that are currently indexed.
+
+### 7. get_search_history
+Get search history for a session.
+- **sessionId** (required): Session ID to retrieve history for
+
+### 8. start_reindex
+Start a reindex operation to update the index.
+- **dirPath** (required): Directory to reindex
+- **mode** (optional): 'full', 'incremental', or 'smart' (default: incremental)
+
+### 9. get_reindex_status
+Check the status of a reindex operation.
+- **reindexId** (required): Reindex operation ID
+
+### 10. get_documentation
+Get this documentation about NGAO Search capabilities.
+
+## Supported Languages
+- TypeScript/JavaScript
+- Python
+- JSON
+- YAML
+- Markdown
+
+## How to Use
+
+1. **Setup**: Run \`npx @ngao/search@alpha --setup\` to configure Claude Desktop integration
+
+2. **Ask Claude**: Once setup, you can ask Claude questions about your code:
+   - "How does authentication work in this project?"
+   - "Find all database queries"
+   - "Show me the error handling pattern"
+   - "What's the structure of the config system?"
+
+3. **Claude uses NGAO Search**: Behind the scenes, Claude uses the search tools to:
+   - Search your codebase for relevant files
+   - Extract code blocks and documentation
+   - Understand the project structure
+   - Provide accurate, context-aware answers
+
+## Configuration
+
+Project configuration is stored in \`.ngao-search.json\`:
+\`\`\`json
+{
+  "port": 3000,
+  "indexDir": ".ngao-search-index",
+  "includePaths": ["**/*.ts", "**/*.js", "**/*.py", "**/*.md"],
+  "excludePaths": ["node_modules/**", "dist/**", ".git/**"]
+}
+\`\`\`
+
+## Tips for Best Results
+
+1. **Index the right directories**: Make sure your project root is indexed
+2. **Use specific queries**: "Find authentication handlers" works better than "auth"
+3. **Provide context**: Tell Claude what you're working on
+4. **Ask follow-ups**: Claude remembers the search context
+
+## Troubleshooting
+
+- **No results**: Try simpler search terms
+- **Slow searches**: Large projects may take longer initially
+- **Need to reindex**: Run \`start_reindex\` with your project directory
+`;
 /**
  * All tool schemas as an object map
  */
@@ -20191,6 +20298,7 @@ exports.toolSchemas = {
     start_reindex: exports.StartReindexInputSchema,
     get_reindex_status: exports.GetReindexStatusInputSchema,
     list_indexed_dirs: exports.ListIndexedDirsInputSchema,
+    get_documentation: exports.GetDocumentationInputSchema,
 };
 /**
  * Tool metadata mapping tool names to descriptions
@@ -20233,6 +20341,10 @@ exports.toolMetadata = {
         description: 'List all indexed directories',
         schema: exports.ListIndexedDirsInputSchema,
     },
+    get_documentation: {
+        description: 'Get NGAO Search documentation and capabilities',
+        schema: exports.GetDocumentationInputSchema,
+    },
 };
 
 
@@ -28821,6 +28933,14 @@ function fromJSONSchema(schema, params) {
 }
 
 
+/***/ },
+
+/***/ 3785
+(module) {
+
+"use strict";
+module.exports = require("readline");
+
 /***/ },
 
 /***/ 3835
@@ -33307,6 +33427,121 @@ exports.BlockImpl = BlockImpl;
 "use strict";
 module.exports = require("node:buffer");
 
+/***/ },
+
+/***/ 4600
+(__unused_webpack_module, exports, __webpack_require__) {
+
+"use strict";
+
+/**
+ * Unified Entry Point for NGAO Search
+ * Supports multiple transport modes: stdio (MCP) or http (REST)
+ *
+ * Transport selection via environment variable:
+ * - MCP_TRANSPORT=stdio  - Start MCP stdio server only (for Claude Desktop)
+ * - MCP_TRANSPORT=http   - Start REST HTTP server only (default)
+ * - --setup             - Run interactive MCP setup for Claude
+ *
+ * All transports share the same NgaoSearchService instance
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+const ngao_search_service_1 = __webpack_require__(9055);
+const mcp_transport_1 = __webpack_require__(6716);
+const rest_transport_1 = __webpack_require__(1256);
+const logger_1 = __webpack_require__(1789);
+// Check for --setup flag for interactive setup
+const args = process.argv.slice(2);
+const setupMode = args.includes('--setup') || process.env.NGAO_SETUP === 'true';
+// When setup completes, auto-start in MCP stdio mode for Claude
+if (setupMode) {
+    process.env.MCP_TRANSPORT = 'stdio';
+}
+const transport = (process.env.MCP_TRANSPORT || 'http').toLowerCase();
+const httpPort = process.env.PORT ? parseInt(process.env.PORT, 10) : 0; // 0 = random available port
+/**
+ * Main async function
+ */
+async function main() {
+    // Run setup first if requested, then continue to start server
+    if (setupMode) {
+        try {
+            const { setupMCP } = await Promise.resolve().then(() => __importStar(__webpack_require__(5021)));
+            const { projectDir, port } = await setupMCP();
+            // Set environment vars for server startup
+            process.env.NGAO_SEARCH_PROJECT = projectDir;
+            if (port)
+                process.env.NGAO_SEARCH_PORT = port;
+            console.log('\n🚀 Starting NGAO Search MCP server...\n');
+            // Continue to server startup below
+        }
+        catch (error) {
+            console.error('Setup failed:', error);
+            process.exit(1);
+        }
+    }
+    try {
+        // Create shared service instance
+        const service = new ngao_search_service_1.NgaoSearchService();
+        switch (transport) {
+            case 'stdio': {
+                const logger = (0, logger_1.createLogger)('stdio');
+                logger.info('Transport: MCP stdio (Claude Desktop)');
+                logger.info('Initializing NgaoSearchService');
+                const mcpTransport = new mcp_transport_1.McpTransport(service, logger);
+                await mcpTransport.start();
+                logger.info('NGAO Search server started successfully');
+                break;
+            }
+            case 'http': {
+                const logger = (0, logger_1.createLogger)('http');
+                logger.info('Transport: HTTP REST API');
+                logger.info('Initializing NgaoSearchService');
+                const restTransport = new rest_transport_1.RestTransport(service, logger);
+                restTransport.start(httpPort);
+                logger.info('NGAO Search server started successfully');
+                break;
+            }
+            default:
+                console.error(`❌ Unknown transport: ${transport}`);
+                console.error('   Valid options: stdio, http');
+                console.error('   Default: http');
+                process.exit(1);
+        }
+    }
+    catch (error) {
+        console.error('❌ Failed to start NGAO Search server:');
+        console.error(error);
+        process.exit(1);
+    }
+}
+// Start the server
+main();
+
+
 /***/ },
 
 /***/ 4633
@@ -34257,6 +34492,154 @@ function parseLiteralDef(def, refs) {
 exports.parseLiteralDef = parseLiteralDef;
 
 
+/***/ },
+
+/***/ 5021
+(__unused_webpack_module, exports, __webpack_require__) {
+
+"use strict";
+
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.setupMCP = void 0;
+const fs = __importStar(__webpack_require__(9896));
+const path = __importStar(__webpack_require__(6928));
+const readline = __importStar(__webpack_require__(3785));
+const rl = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout,
+});
+function question(prompt) {
+    return new Promise((resolve) => {
+        rl.question(prompt, (answer) => {
+            resolve(answer);
+        });
+    });
+}
+async function setupMCP() {
+    console.log('\n🔧 NGAO Search - MCP Setup for Claude Code (VSCode)\n');
+    const homeDir = process.env.HOME || process.env.USERPROFILE || '.';
+    // VSCode user settings path (macOS/Linux)
+    let vscodeSettingsPath;
+    if (process.platform === 'darwin') {
+        // macOS
+        vscodeSettingsPath = path.join(homeDir, 'Library/Application Support/Code/User/settings.json');
+    }
+    else if (process.platform === 'win32') {
+        // Windows
+        vscodeSettingsPath = path.join(homeDir, 'AppData/Roaming/Code/User/settings.json');
+    }
+    else {
+        // Linux
+        vscodeSettingsPath = path.join(homeDir, '.config/Code/User/settings.json');
+    }
+    // Check if already set up
+    if (fs.existsSync(vscodeSettingsPath)) {
+        const existingSettings = JSON.parse(fs.readFileSync(vscodeSettingsPath, 'utf8'));
+        if (existingSettings['claude.mcp']?.servers?.['ngao-search']) {
+            console.log('✅ NGAO Search is already configured in Claude Code!');
+            const projectDir = process.env.NGAO_SEARCH_PROJECT || process.cwd();
+            const port = '3000';
+            rl.close();
+            return { projectDir, port };
+        }
+    }
+    // Ask for project directory
+    const projectDir = await question('📁 Enter your project directory path (or press Enter for current): ');
+    const resolvedProjectDir = projectDir.trim() || process.cwd();
+    // Ask for port
+    const portAnswer = await question('🔌 Enter port for MCP server (default: 3000): ');
+    const port = portAnswer.trim() || '3000';
+    // Server config to add
+    const ngaoServerConfig = {
+        command: 'npx',
+        args: ['@ngao/search'],
+        env: {
+            NGAO_SEARCH_PORT: port,
+            NGAO_SEARCH_PROJECT: resolvedProjectDir,
+            MCP_TRANSPORT: 'stdio',
+        },
+    };
+    // Setup Claude Code (VSCode)
+    const vscodeSettingsDir = path.dirname(vscodeSettingsPath);
+    if (!fs.existsSync(vscodeSettingsDir)) {
+        fs.mkdirSync(vscodeSettingsDir, { recursive: true });
+    }
+    let vscodeSettings = {};
+    if (fs.existsSync(vscodeSettingsPath)) {
+        vscodeSettings = JSON.parse(fs.readFileSync(vscodeSettingsPath, 'utf8'));
+    }
+    vscodeSettings['claude.mcp'] = vscodeSettings['claude.mcp'] || {};
+    vscodeSettings['claude.mcp'].servers = vscodeSettings['claude.mcp'].servers || {};
+    vscodeSettings['claude.mcp'].servers['ngao-search'] = ngaoServerConfig;
+    fs.writeFileSync(vscodeSettingsPath, JSON.stringify(vscodeSettings, null, 2));
+    console.log(`\n✅ Claude Code (VSCode) config updated: ${vscodeSettingsPath}`);
+    // Create .ngao-search config in project
+    const projectConfigPath = path.join(resolvedProjectDir, '.ngao-search.json');
+    if (!fs.existsSync(projectConfigPath)) {
+        const projectConfig = {
+            port,
+            indexDir: path.join(resolvedProjectDir, '.ngao-search-index'),
+            includePaths: ['**/*.ts', '**/*.tsx', '**/*.js', '**/*.jsx', '**/*.py', '**/*.md'],
+            excludePaths: ['node_modules/**', 'dist/**', '.git/**', '.ngao-search-index/**'],
+        };
+        fs.writeFileSync(projectConfigPath, JSON.stringify(projectConfig, null, 2));
+        console.log(`✅ Project config created: ${projectConfigPath}`);
+    }
+    // Create .mcp-config.json in project for Claude Code auto-detection
+    const mcpConfigPath = path.join(resolvedProjectDir, '.mcp-config.json');
+    const mcpConfig = {
+        mcpServers: {
+            'ngao-search': {
+                command: 'npx',
+                args: ['@ngao/search'],
+                env: {
+                    NGAO_SEARCH_PROJECT: resolvedProjectDir,
+                    MCP_TRANSPORT: 'stdio',
+                },
+            },
+        },
+    };
+    fs.writeFileSync(mcpConfigPath, JSON.stringify(mcpConfig, null, 2));
+    console.log(`✅ MCP config created: ${mcpConfigPath}`);
+    // Show setup instructions
+    console.log('\n📝 Setup Complete!\n');
+    console.log('✨ NGAO Search is now integrated with Claude Code');
+    console.log('\nℹ️  Configuration Details:');
+    console.log('📍 Project directory: ' + resolvedProjectDir);
+    console.log('🔌 Server port: ' + port);
+    console.log('📌 Claude Code global config: ' + vscodeSettingsPath);
+    console.log('📌 Project config: ' + projectConfigPath);
+    console.log('📌 MCP config: ' + mcpConfigPath + '\n');
+    console.log('🚀 Next: Restart VSCode to start using NGAO Search!\n');
+    rl.close();
+    return { projectDir: resolvedProjectDir, port };
+}
+exports.setupMCP = setupMCP;
+
+
 /***/ },
 
 /***/ 5039
@@ -43630,6 +44013,7 @@ const mcp_js_1 = __webpack_require__(7011);
 const stdio_js_1 = __webpack_require__(6166);
 const zod_1 = __webpack_require__(7552);
 const tool_registry_1 = __webpack_require__(8223);
+const tool_schemas_1 = __webpack_require__(2439);
 /**
  * MCP Transport - Handles MCP protocol over stdio
  */
@@ -43772,6 +44156,16 @@ class McpTransport {
                 ],
             };
         });
+        this.server.tool('get_documentation', 'Get NGAO Search documentation and capabilities', {}, async () => {
+            return {
+                content: [
+                    {
+                        type: 'text',
+                        text: tool_schemas_1.NGAO_DOCUMENTATION,
+                    },
+                ],
+            };
+        });
     }
     /**
      * Route tool calls to service methods
@@ -65974,74 +66368,13 @@ exports.PythonParser = PythonParser;
 /******/ 	})();
 /******/ 	
 /************************************************************************/
-var __webpack_exports__ = {};
-// This entry needs to be wrapped in an IIFE because it needs to be in strict mode.
-(() => {
-"use strict";
-var exports = __webpack_exports__;
-
-/**
- * Unified Entry Point for NGAO Search
- * Supports multiple transport modes: stdio (MCP) or http (REST)
- *
- * Transport selection via environment variable:
- * - MCP_TRANSPORT=stdio  - Start MCP stdio server only (for Claude Desktop)
- * - MCP_TRANSPORT=http   - Start REST HTTP server only (default)
- *
- * All transports share the same NgaoSearchService instance
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-const ngao_search_service_1 = __webpack_require__(9055);
-const mcp_transport_1 = __webpack_require__(6716);
-const rest_transport_1 = __webpack_require__(1256);
-const logger_1 = __webpack_require__(1789);
-const transport = (process.env.MCP_TRANSPORT || 'http').toLowerCase();
-const httpPort = process.env.PORT ? parseInt(process.env.PORT, 10) : 0; // 0 = random available port
-/**
- * Main async function
- */
-async function main() {
-    try {
-        // Create shared service instance
-        const service = new ngao_search_service_1.NgaoSearchService();
-        switch (transport) {
-            case 'stdio': {
-                const logger = (0, logger_1.createLogger)('stdio');
-                logger.info('Transport: MCP stdio (Claude Desktop)');
-                logger.info('Initializing NgaoSearchService');
-                const mcpTransport = new mcp_transport_1.McpTransport(service, logger);
-                await mcpTransport.start();
-                logger.info('NGAO Search server started successfully');
-                break;
-            }
-            case 'http': {
-                const logger = (0, logger_1.createLogger)('http');
-                logger.info('Transport: HTTP REST API');
-                logger.info('Initializing NgaoSearchService');
-                const restTransport = new rest_transport_1.RestTransport(service, logger);
-                restTransport.start(httpPort);
-                logger.info('NGAO Search server started successfully');
-                break;
-            }
-            default:
-                console.error(`❌ Unknown transport: ${transport}`);
-                console.error('   Valid options: stdio, http');
-                console.error('   Default: http');
-                process.exit(1);
-        }
-    }
-    catch (error) {
-        console.error('❌ Failed to start NGAO Search server:');
-        console.error(error);
-        process.exit(1);
-    }
-}
-// Start the server
-main();
-
-})();
-
-module.exports = __webpack_exports__;
+/******/ 	
+/******/ 	// startup
+/******/ 	// Load entry module and return exports
+/******/ 	// This entry module is referenced by other modules so it can't be inlined
+/******/ 	var __webpack_exports__ = __webpack_require__(4600);
+/******/ 	module.exports = __webpack_exports__;
+/******/ 	
 /******/ })()
 ;
 //# sourceMappingURL=main.js.map

package/package.json

@@ -1,9 +1,12 @@
 {
   "name": "@ngao/search",
-  "version": "1.0.0-alpha.1",
+  "version": "1.0.0-alpha.10",
   "description": "NGAO Search - Model Context Protocol Server for Local Code/Document Search with LLM-Friendly Output",
   "main": "dist/main.js",
   "types": "dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
   "bin": {
     "ngao-search": "dist-bundled/main.js"
   },
@@ -14,7 +17,8 @@
   "scripts": {
     "build": "npm run build:backend && npm run clean:dist",
     "build:backend": "webpack --config webpack.backend.config.js --mode production && tsc --emitDeclarationOnly",
-    "build:bundled": "BUNDLE=true webpack --config webpack.backend.config.js && npm run clean:dist:bundled",
+    "build:bundled": "BUNDLE=true webpack --config webpack.backend.config.js && npm run add:shebang && npm run clean:dist:bundled",
+    "add:shebang": "node -e \"const fs=require('fs');const f='dist-bundled/main.js';const c=fs.readFileSync(f,'utf8');if(!c.startsWith('#!')){fs.writeFileSync(f,'#!/usr/bin/env node\\n'+c);console.log('✓ Shebang added');}\"",
     "clean:dist": "rm -rf dist/backend dist/cli dist/mcp dist/shared dist/index.* dist/**/*.map dist/*.map 2>/dev/null; true",
     "clean:dist:bundled": "rm -rf dist-bundled/backend dist-bundled/cli dist-bundled/mcp dist-bundled/shared dist-bundled/*.map 2>/dev/null; true",
     "start": "npm run build && node dist/main.js",