Add workspace validation

Author: peteretelej

package.json

@@ -1,6 +1,6 @@
 {
   "name": "directory-indexer",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "AI-powered directory indexing with semantic search for MCP servers",
   "main": "dist/cli.js",
   "bin": {

src/mcp-handlers.ts

@@ -86,25 +86,39 @@ export async function handleIndexTool(args: unknown, config: Config): Promise<Ca
   };
 }
 
+async function validateWorkspace(workspace?: string): Promise<{ workspace?: string; message?: string }> {
+  if (!workspace) return { workspace };
+  
+  const config = (await import('./config.js')).loadConfig();
+  const { getAvailableWorkspaces } = await import('./config.js');
+  const availableWorkspaces = getAvailableWorkspaces(config);
+  
+  if (availableWorkspaces.includes(workspace)) {
+    return { workspace };
+  }
+  
+  // Invalid workspace - search all content with informative message
+  const message = availableWorkspaces.length > 0
+    ? `Note: Workspace '${workspace}' not found. Searching all content instead. Available workspaces: ${availableWorkspaces.join(', ')}. Use server_info tool to see workspace details.`
+    : `Note: Workspace '${workspace}' not found and no workspaces are configured. Searching all indexed content.`;
+  
+  return { workspace: undefined, message };
+}
+
 export async function handleSearchTool(args: unknown): Promise<CallToolResult> {
   if (!isSearchToolArgs(args)) {
     throw new Error('query is required');
   }
 
-  const options = { 
-    limit: args.limit || 10,
-    workspace: args.workspace
-  };
+  const { workspace, message } = await validateWorkspace(args.workspace);
+  const results = await searchContent(args.query, { limit: args.limit || 10, workspace });
 
-  const results = await searchContent(args.query, options);
+  const response = message 
+    ? `${message}\n\n${JSON.stringify(results, null, 2)}`
+    : JSON.stringify(results, null, 2);
 
   return {
-    content: [
-      {
-        type: 'text',
-        text: JSON.stringify(results, null, 2)
-      }
-    ]
+    content: [{ type: 'text', text: response }]
   };
 }
 
@@ -113,19 +127,15 @@ export async function handleSimilarFilesTool(args: unknown): Promise<CallToolRes
     throw new Error('file_path is required');
   }
 
-  const results = await findSimilarFiles(
-    args.file_path, 
-    args.limit || 10,
-    args.workspace
-  );
+  const { workspace, message } = await validateWorkspace(args.workspace);
+  const results = await findSimilarFiles(args.file_path, args.limit || 10, workspace);
+  
+  const response = message 
+    ? `${message}\n\n${JSON.stringify(results, null, 2)}`
+    : JSON.stringify(results, null, 2);
 
   return {
-    content: [
-      {
-        type: 'text',
-        text: JSON.stringify(results, null, 2)
-      }
-    ]
+    content: [{ type: 'text', text: response }]
   };
 }
 

src/mcp.ts

@@ -108,7 +108,7 @@ Example queries:
         },
         workspace: {
           type: 'string',
-          description: 'Optional workspace name to filter search results. Only files within the workspace directories will be searched. Use server_info to see available workspaces.'
+          description: 'Optional workspace name to filter search results. Only files within the workspace directories will be searched. IMPORTANT: Use server_info tool first to discover available workspace names - using invalid workspace names will result in empty results.'
         }
       },
       required: ['query']
@@ -150,7 +150,7 @@ Returns file paths with similarity scores. Use get_content to read full files or
         },
         workspace: {
           type: 'string',
-          description: 'Optional workspace name to filter results. Only files within the workspace directories will be considered. Use server_info to see available workspaces.'
+          description: 'Optional workspace name to filter results. Only files within the workspace directories will be considered. IMPORTANT: Use server_info tool first to discover available workspace names - using invalid workspace names will result in empty results.'
         }
       },
       required: ['file_path']
@@ -235,6 +235,7 @@ Returns chunk content as text. Use this with chunk IDs from search results to ge
     description: `Get information about server status and indexed content. Shows what directories and files are available for search.
 
 When to use this tool:
+- REQUIRED: Check available workspace names before using workspace parameter in search or similar_files tools
 - Check what content is already indexed before performing searches
 - Verify system is working properly
 - See indexing statistics and status
@@ -244,14 +245,16 @@ How it works:
 - Reports total indexed directories, files, and chunks
 - Shows database size and last indexing time
 - Lists all indexed directories with file counts
+- Lists all configured workspaces with their paths and file counts
 - Reports any errors or issues
 
 Examples:
+- Check workspaces before searching: "What workspaces are available?"
 - Check before searching: "What content is indexed?"
 - Verify after indexing: "Did the indexing complete successfully?"
 - Monitor system: "How many files are searchable?"
 
-Returns server version, indexing statistics, directory list, and any errors. Use this to understand what content is available for search and similar_files tools.`,
+Returns server version, indexing statistics, directory list, workspace information, and any errors. IMPORTANT: Always use this tool first to discover available workspace names when you need to search within specific workspaces.`,
     inputSchema: {
       type: 'object',
       properties: {},

tests/mcp-handlers.test.ts

@@ -26,6 +26,12 @@ vi.mock('../src/storage.js', () => ({
   getIndexStatus: vi.fn()
 }));
 
+vi.mock('../src/config.js', () => ({
+  ...vi.importActual('../src/config.js'),
+  loadConfig: vi.fn(),
+  getAvailableWorkspaces: vi.fn()
+}));
+
 describe('MCP Handlers Unit Tests', () => {
   beforeEach(() => {
     vi.clearAllMocks();
@@ -70,8 +76,11 @@ Errors: [
   describe('handleSearchTool', () => {
     it('should handle valid search request', async () => {
       const { searchContent } = await import('../src/search.js');
+      const { loadConfig, getAvailableWorkspaces } = await import('../src/config.js');
       const mockResults = [{ filePath: '/test.md', score: 0.9, fileSizeBytes: 1024, matchingChunks: 2, chunks: [] }];
       vi.mocked(searchContent).mockResolvedValue(mockResults);
+      vi.mocked(loadConfig).mockReturnValue({ workspaces: { docs: { paths: ['/docs'], isValid: true } } } as any);
+      vi.mocked(getAvailableWorkspaces).mockReturnValue(['docs']);
 
       const args = { query: 'test search', limit: 5, workspace: 'docs' };
 
@@ -97,6 +106,39 @@ Errors: [
       expect(searchContent).toHaveBeenCalledWith('test', { limit: 10, workspace: undefined });
     });
 
+    it('should handle invalid workspace by searching all content', async () => {
+      const { searchContent } = await import('../src/search.js');
+      const { loadConfig, getAvailableWorkspaces } = await import('../src/config.js');
+      const mockResults = [{ filePath: '/test.md', score: 0.9, fileSizeBytes: 1024, matchingChunks: 2, chunks: [] }];
+      vi.mocked(searchContent).mockResolvedValue(mockResults);
+      vi.mocked(loadConfig).mockReturnValue({ workspaces: { docs: { paths: ['/docs'], isValid: true } } } as any);
+      vi.mocked(getAvailableWorkspaces).mockReturnValue(['docs']);
+
+      const args = { query: 'test search', workspace: 'invalid' };
+
+      const result = await handleSearchTool(args);
+
+      expect(searchContent).toHaveBeenCalledWith('test search', { limit: 10, workspace: undefined });
+      expect(result.content[0].text).toContain('Workspace \'invalid\' not found');
+      expect(result.content[0].text).toContain('Available workspaces: docs');
+    });
+
+    it('should handle invalid workspace when no workspaces configured', async () => {
+      const { searchContent } = await import('../src/search.js');
+      const { loadConfig, getAvailableWorkspaces } = await import('../src/config.js');
+      const mockResults = [{ filePath: '/test.md', score: 0.9, fileSizeBytes: 1024, matchingChunks: 2, chunks: [] }];
+      vi.mocked(searchContent).mockResolvedValue(mockResults);
+      vi.mocked(loadConfig).mockReturnValue({ workspaces: {} } as any);
+      vi.mocked(getAvailableWorkspaces).mockReturnValue([]);
+
+      const args = { query: 'test search', workspace: 'invalid' };
+
+      const result = await handleSearchTool(args);
+
+      expect(searchContent).toHaveBeenCalledWith('test search', { limit: 10, workspace: undefined });
+      expect(result.content[0].text).toContain('no workspaces are configured');
+    });
+
     it('should throw error for missing query', async () => {
       await expect(handleSearchTool({})).rejects.toThrow('query is required');
       await expect(handleSearchTool(null)).rejects.toThrow('query is required');
@@ -107,8 +149,11 @@ Errors: [
   describe('handleSimilarFilesTool', () => {
     it('should handle valid similar files request', async () => {
       const { findSimilarFiles } = await import('../src/search.js');
+      const { loadConfig, getAvailableWorkspaces } = await import('../src/config.js');
       const mockResults = [{ filePath: '/similar.md', score: 0.8, fileSizeBytes: 512 }];
       vi.mocked(findSimilarFiles).mockResolvedValue(mockResults);
+      vi.mocked(loadConfig).mockReturnValue({ workspaces: { code: { paths: ['/code'], isValid: true } } } as any);
+      vi.mocked(getAvailableWorkspaces).mockReturnValue(['code']);
 
       const args = { file_path: '/test.md', limit: 3, workspace: 'code' };
 
@@ -134,6 +179,39 @@ Errors: [
       expect(findSimilarFiles).toHaveBeenCalledWith('/test.md', 10, undefined);
     });
 
+    it('should handle invalid workspace by searching all content', async () => {
+      const { findSimilarFiles } = await import('../src/search.js');
+      const { loadConfig, getAvailableWorkspaces } = await import('../src/config.js');
+      const mockResults = [{ filePath: '/similar.md', score: 0.8, fileSizeBytes: 512 }];
+      vi.mocked(findSimilarFiles).mockResolvedValue(mockResults);
+      vi.mocked(loadConfig).mockReturnValue({ workspaces: { code: { paths: ['/code'], isValid: true } } } as any);
+      vi.mocked(getAvailableWorkspaces).mockReturnValue(['code']);
+
+      const args = { file_path: '/test.md', workspace: 'invalid' };
+
+      const result = await handleSimilarFilesTool(args);
+
+      expect(findSimilarFiles).toHaveBeenCalledWith('/test.md', 10, undefined);
+      expect(result.content[0].text).toContain('Workspace \'invalid\' not found');
+      expect(result.content[0].text).toContain('Available workspaces: code');
+    });
+
+    it('should handle invalid workspace when no workspaces configured', async () => {
+      const { findSimilarFiles } = await import('../src/search.js');
+      const { loadConfig, getAvailableWorkspaces } = await import('../src/config.js');
+      const mockResults = [{ filePath: '/similar.md', score: 0.8, fileSizeBytes: 512 }];
+      vi.mocked(findSimilarFiles).mockResolvedValue(mockResults);
+      vi.mocked(loadConfig).mockReturnValue({ workspaces: {} } as any);
+      vi.mocked(getAvailableWorkspaces).mockReturnValue([]);
+
+      const args = { file_path: '/test.md', workspace: 'invalid' };
+
+      const result = await handleSimilarFilesTool(args);
+
+      expect(findSimilarFiles).toHaveBeenCalledWith('/test.md', 10, undefined);
+      expect(result.content[0].text).toContain('no workspaces are configured');
+    });
+
     it('should throw error for missing file_path', async () => {
       await expect(handleSimilarFilesTool({})).rejects.toThrow('file_path is required');
       await expect(handleSimilarFilesTool(null)).rejects.toThrow('file_path is required');