sfcc-dev-mcp 1.0.15 → 1.0.19

package/docs-site/public/llms.txt

@@ -1,47 +0,0 @@
-# SFCC Development MCP Server
-
-> A comprehensive Model Context Protocol (MCP) server that provides AI assistants with direct access to Salesforce B2C Commerce Cloud development tools, documentation, best practices, and real-time debugging capabilities.
-
-This server bridges the gap between AI assistants and SFCC development workflows, offering both documentation-only mode (no credentials required) and full mode (with live SFCC instance access). It provides 36 tools across 8 categories including complete SFCC API documentation, curated best practices guides, enhanced SFRA documentation, real-time log analysis, system object exploration, and automated cartridge generation.
-
-Key architectural principles:
-- **Capability-gated**: Tools requiring SFCC credentials are only exposed when valid configuration is provided
-- **Modular handlers**: Clean separation between tool routing and domain logic  
-- **Dependency injection**: Testable architecture with service abstractions
-- **Performance optimized**: Efficient caching and range request optimization for log analysis
-
-## Core Documentation
-
-- [Installation Guide](https://sfcc-mcp-dev.rhino-inquisitor.com/#/installation): Step-by-step setup instructions for different AI interfaces (Claude Desktop, Cursor, GitHub Copilot)
-- [Configuration Guide](https://sfcc-mcp-dev.rhino-inquisitor.com/#/configuration): Detailed configuration options for both documentation-only and full modes
-- [Available Tools](https://sfcc-mcp-dev.rhino-inquisitor.com/#/tools): Comprehensive list of all 36 tools organized by category with usage examples
-- [Features Overview](https://sfcc-mcp-dev.rhino-inquisitor.com/#/features): Complete feature breakdown including operating modes and capabilities
-
-## Development Resources
-
-- [Development Guide](https://sfcc-mcp-dev.rhino-inquisitor.com/#/development): Architecture overview, adding new tools, testing guidelines, and contribution workflow
-- [Examples & Use Cases](https://sfcc-mcp-dev.rhino-inquisitor.com/#/examples): Practical examples for documentation access, log analysis, cartridge generation, and debugging workflows
-- [AI Interface Setup](https://sfcc-mcp-dev.rhino-inquisitor.com/#/ai-interfaces): Platform-specific setup guides for Claude Desktop, Cursor IDE, and GitHub Copilot integration
-
-## Security & Best Practices
-
-- [Security Considerations](https://sfcc-mcp-dev.rhino-inquisitor.com/#/security): Credential management, local security practices, and network security guidelines
-- [Troubleshooting Guide](https://sfcc-mcp-dev.rhino-inquisitor.com/#/troubleshooting): Common issues, debugging steps, and configuration validation
-
-## Tool Categories
-
-- **SFCC Documentation Tools (5 tools)**: Complete API class information, method search, and namespace exploration
-- **Best Practices Guides (4 tools)**: Curated development guidelines for cartridges, hooks, controllers, security, and performance
-- **SFRA Documentation Tools (5 tools)**: Enhanced Storefront Reference Architecture documentation with dynamic discovery
-- **Log Analysis Tools (8 tools)**: Real-time error monitoring, pattern matching, and system health analysis
-- **Job Log Tools (5 tools)**: Specialized job log analysis, execution summaries, and custom job step debugging
-- **System Object Tools (6 tools)**: Custom attribute discovery, site preference management, and schema exploration
-- **Cartridge Generation Tools (1 tool)**: Automated cartridge structure creation with complete project setup
-- **Code Version Tools (2 tools)**: Code version management and deployment activation
-
-## Optional
-
-- [GitHub Repository](https://github.com/taurgis/sfcc-dev-mcp): Source code, issues, and contribution guidelines
-- [NPM Package](https://www.npmjs.com/package/sfcc-dev-mcp): Package installation and version information
-- [CHANGELOG](https://github.com/taurgis/sfcc-dev-mcp/blob/main/CHANGELOG.md): Release notes and version history
-- [Contributing Guidelines](https://github.com/taurgis/sfcc-dev-mcp/blob/main/CONTRIBUTING.md): Development setup and contribution workflow

package/docs-site/scripts/generate-search-index.js

@@ -1,323 +0,0 @@
-#!/usr/bin/env node
-
-/**
- * Search Index Generator for SFCC Development MCP Server Documentation
- *
- * This script automatically generates a search index by parsing React components
- * and extracting searchable content. It replaces the manually maintained search
- * index with an automatically generated one during the build process.
- */
-
-import fs from 'fs';
-import path from 'path';
-import { fileURLToPath } from 'url';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
-// Configuration
-const PAGES_DIR = path.join(__dirname, '../pages');
-const OUTPUT_FILE = path.join(__dirname, '../src/generated-search-index.ts');
-
-/**
- * Route mappings for pages to their URL paths
- */
-const ROUTE_MAPPINGS = {
-  'HomePage.tsx': '/',
-  'ConfigurationPage.tsx': '/configuration/',
-  'AIInterfacesPage.tsx': '/ai-interfaces/',
-  'FeaturesPage.tsx': '/features/',
-  'ToolsPage.tsx': '/tools/',
-  'ExamplesPage.tsx': '/examples/',
-  'SecurityPage.tsx': '/security/',
-  'DevelopmentPage.tsx': '/development/',
-  'TroubleshootingPage.tsx': '/troubleshooting/',
-};
-
-/**
- * Extract content from JSX strings and React elements
- */
-function extractTextFromJSX(content) {
-  const textContent = [];
-
-  // Remove JSX tags but keep the text content
-  const cleanContent = content
-    // Remove comments
-    .replace(/\/\*[\s\S]*?\*\//g, '')
-    .replace(/\/\/.*$/gm, '')
-    // Remove import statements
-    .replace(/^import\s+.*$/gm, '')
-    // Remove className and other JSX attributes
-    .replace(/className=["'`][^"'`]*["'`]/g, '')
-    .replace(/\w+={[^}]*}/g, '');
-
-  // Extract text between JSX tags
-  const textRegex = />([^<]+)</g;
-  let match;
-  while ((match = textRegex.exec(cleanContent)) !== null) {
-    const text = match[1].trim();
-    // Filter out empty strings, JSX expressions, and very short text
-    if (text &&
-        !text.startsWith('{') &&
-        !text.includes('className') &&
-        !text.includes('src=') &&
-        text.length > 3 &&
-        !/^[{\s}]*$/.test(text)) {
-      textContent.push(text);
-    }
-  }
-
-  // Also extract string literals that might contain content
-  const stringRegex = /["'`]([^"'`{]+)["'`]/g;
-  while ((match = stringRegex.exec(cleanContent)) !== null) {
-    const text = match[1].trim();
-    if (text &&
-        text.length > 10 &&
-        !text.includes('className') &&
-        !text.includes('src=') &&
-        !text.includes('href=') &&
-        !text.startsWith('http') &&
-        (!text.includes('.') || text.includes(' '))) { // Allow sentences with periods
-      textContent.push(text);
-    }
-  }
-
-  // Clean up the extracted text
-  return textContent
-    .map(text => text
-      .replace(/\s+/g, ' ') // Normalize whitespace
-      .replace(/[{}]/g, '') // Remove remaining braces
-      .trim())
-    .filter(text => text.length > 5)
-    .join(' ');
-}
-
-/**
- * Extract headings and sections from a React component
- */
-function parseReactComponent(filePath, content) {
-  const results = [];
-
-  // Get the page title from the route mapping
-  const relativePath = path.relative(PAGES_DIR, filePath);
-  const routePath = ROUTE_MAPPINGS[relativePath];
-
-  if (!routePath) {
-    console.warn(`Warning: No route mapping found for ${relativePath}`);
-    return results;
-  }
-
-  // Extract page title from component name or H1 tags
-  let pageTitle = 'Unknown Page';
-  const titleMatch = content.match(/pageTitle\s*[:=]\s*["'`]([^"'`]+)["'`]/);
-  if (titleMatch) {
-    pageTitle = titleMatch[1];
-  } else {
-    // Fallback: extract from H1 tags
-    const h1Match = content.match(/<h1[^>]*>([^<]+)<\/h1>/i);
-    if (h1Match) {
-      pageTitle = h1Match[1].replace(/\{[^}]*\}/g, '').trim();
-    }
-  }
-
-  // Extract sections based on headings (H1, H2, H3 components and regular h1-h3 tags)
-  const jsxComponentPattern = /<H([123])[^>]*id=["']([^"']+)["'][^>]*>([^<]+)<\/H[123]>/gi;
-  const regularHeadingPattern = /<(h[1-3])[^>]*(?:id=["']([^"']+)["'])?[^>]*>([^<]+)<\/(h[1-3])>/gi;
-  const sections = [];
-  let match;
-
-  // First, extract JSX component headings (H1, H2, H3)
-  while ((match = jsxComponentPattern.exec(content)) !== null) {
-    const heading = match[3].trim();
-    const headingId = match[2];
-    const level = parseInt(match[1]);
-
-    if (heading && heading.length > 1) {
-      sections.push({
-        heading,
-        headingId,
-        level,
-        position: match.index,
-      });
-    }
-  }
-
-  // Reset regex for next pass
-  regularHeadingPattern.lastIndex = 0;
-
-  // Then, extract regular HTML headings
-  while ((match = regularHeadingPattern.exec(content)) !== null) {
-    const heading = match[3].replace(/\{[^}]*\}/g, '').trim();
-    const headingId = match[2];
-    const level = parseInt(match[1].charAt(1));
-
-    if (heading && heading.length > 1 && !heading.includes('className')) {
-      sections.push({
-        heading,
-        headingId,
-        level,
-        position: match.index,
-      });
-    }
-  }
-
-  // Sort sections by their position in the document
-  sections.sort((a, b) => a.position - b.position);
-
-  // Filter out duplicate headings at the same position, preferring those with a headingId
-  const filteredSections = [];
-  for (let i = 0; i < sections.length; i++) {
-    const curr = sections[i];
-    const next = sections[i + 1];
-    if (
-      next &&
-      curr.position === next.position &&
-      curr.heading === next.heading
-    ) {
-      // Prefer the one with headingId
-      if (curr.headingId) {
-        filteredSections.push(curr);
-      } else if (next.headingId) {
-        filteredSections.push(next);
-      }
-      i++; // Skip the next one
-    } else {
-      filteredSections.push(curr);
-    }
-  }
-
-  if (filteredSections.length === 0) {
-    // If no headings found, create a single entry for the whole page
-    const textContent = extractTextFromJSX(content);
-    results.push({
-      path: routePath,
-      pageTitle,
-      heading: pageTitle,
-      headingId: null, // No heading ID for fallback case
-      content: textContent.substring(0, 500), // Limit content length
-    });
-    return results;
-  }
-
-  // Create search entries for each section
-  filteredSections.forEach((section, index) => {
-    const nextSection = filteredSections[index + 1];
-    const sectionStart = section.position;
-    const sectionEnd = nextSection ? nextSection.position : content.length;
-
-    const sectionContent = content.substring(sectionStart, sectionEnd);
-    const textContent = extractTextFromJSX(sectionContent);
-
-    if (textContent.trim().length > 10) { // Only include sections with meaningful content
-      results.push({
-        path: routePath,
-        pageTitle,
-        heading: section.heading,
-        headingId: section.headingId || null, // Ensure the property is always present
-        content: textContent.substring(0, 300), // Limit content length per section
-      });
-    }
-  });
-
-  return results;
-}
-
-/**
- * Recursively find all React component files
- */
-function findReactFiles(dir) {
-  const files = [];
-
-  function traverse(currentDir) {
-    const entries = fs.readdirSync(currentDir, { withFileTypes: true });
-
-    for (const entry of entries) {
-      const fullPath = path.join(currentDir, entry.name);
-
-      if (entry.isDirectory()) {
-        traverse(fullPath);
-      } else if (entry.isFile() && entry.name.endsWith('.tsx')) {
-        files.push(fullPath);
-      }
-    }
-  }
-
-  traverse(dir);
-  return files;
-}
-
-/**
- * Generate the search index
- */
-function generateSearchIndex() {
-  console.log('🔍 Generating search index...');
-
-  const reactFiles = findReactFiles(PAGES_DIR);
-  const searchIndex = [];
-
-  console.log(`Found ${reactFiles.length} React files to process`);
-
-  for (const filePath of reactFiles) {
-    try {
-      const content = fs.readFileSync(filePath, 'utf-8');
-      const entries = parseReactComponent(filePath, content);
-      searchIndex.push(...entries);
-
-      console.log(`  ✓ Processed ${path.relative(PAGES_DIR, filePath)} (${entries.length} entries)`);
-    } catch (error) {
-      console.error(`  ✗ Failed to process ${filePath}:`, error.message);
-    }
-  }
-
-  console.log(`Generated ${searchIndex.length} search entries`);
-
-  return searchIndex;
-}
-
-/**
- * Write the generated index to a TypeScript file
- */
-function writeSearchIndex(searchIndex) {
-  const outputDir = path.dirname(OUTPUT_FILE);
-  if (!fs.existsSync(outputDir)) {
-    fs.mkdirSync(outputDir, { recursive: true });
-  }
-
-  const tsContent = `// This file is auto-generated by scripts/generate-search-index.js
-// Do not edit manually - changes will be overwritten during build
-
-export interface SearchableItem {
-  path: string;
-  pageTitle: string;
-  heading: string;
-  headingId?: string;
-  content: string;
-}
-
-export const GENERATED_SEARCH_INDEX: SearchableItem[] = ${JSON.stringify(searchIndex, null, 2)};
-`;
-
-  fs.writeFileSync(OUTPUT_FILE, tsContent, 'utf-8');
-  console.log(`✅ Search index written to ${path.relative(process.cwd(), OUTPUT_FILE)}`);
-}
-
-/**
- * Main execution
- */
-function main() {
-  try {
-    const searchIndex = generateSearchIndex();
-    writeSearchIndex(searchIndex);
-    console.log('🎉 Search index generation complete!');
-  } catch (error) {
-    console.error('❌ Failed to generate search index:', error);
-    process.exit(1);
-  }
-}
-
-// Run if called directly
-if (import.meta.url === `file://${process.argv[1]}`) {
-  main();
-}
-
-export { generateSearchIndex, writeSearchIndex };

package/docs-site/scripts/generate-sitemap.js

@@ -1,156 +0,0 @@
-#!/usr/bin/env node
-
-/**
- * Sitemap Generator for SFCC Development MCP Server Documentation
- *
- * This script generates an XML sitemap for the SFCC Development MCP Server documentation site.
- * Run this whenever you add new pages or want to update the sitemap.
- *
- * Usage: node scripts/generate-sitemap.js
- */
-
-import fs from 'fs';
-import path from 'path';
-import { fileURLToPath } from 'url';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
-const baseUrl = 'https://sfcc-mcp-dev.rhino-inquisitor.com';
-const currentDate = new Date().toISOString().split('T')[0];
-
-// Define all pages with their priorities and change frequencies
-const pages = [
-  {
-    path: '/',
-    priority: '1.0',
-    changefreq: 'weekly',
-    description: 'SFCC Development MCP Server Homepage',
-  },
-  {
-    path: '/configuration/',
-    priority: '0.9',
-    changefreq: 'monthly',
-    description: 'Configuration Guide',
-  },
-  {
-    path: '/ai-interfaces/',
-    priority: '0.8',
-    changefreq: 'monthly',
-    description: 'AI Interface Setup Guide',
-  },
-  {
-    path: '/features/',
-    priority: '0.8',
-    changefreq: 'monthly',
-    description: 'Features Overview',
-  },
-  {
-    path: '/tools/',
-    priority: '0.8',
-    changefreq: 'monthly',
-    description: 'Available Tools',
-  },
-  {
-    path: '/examples/',
-    priority: '0.8',
-    changefreq: 'monthly',
-    description: 'Examples and Use Cases',
-  },
-  {
-    path: '/security/',
-    priority: '0.7',
-    changefreq: 'monthly',
-    description: 'Security Guidelines',
-  },
-  {
-    path: '/development/',
-    priority: '0.6',
-    changefreq: 'monthly',
-    description: 'Development Guide',
-  },
-  {
-    path: '/troubleshooting/',
-    priority: '0.7',
-    changefreq: 'monthly',
-    description: 'Troubleshooting Guide',
-  },
-];
-
-function generateSitemap() {
-  const header = `<?xml version="1.0" encoding="UTF-8"?>
-<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"
-        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-        xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9
-        http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd">`;
-
-  const footer = `
-</urlset>`;
-
-  const urls = pages.map(page => {
-    // For SSG routing, URLs should point to clean paths without hash fragments
-    const url = page.path === '/' ? baseUrl : `${baseUrl}${page.path}`;
-    return `    
-    <!-- ${page.description} -->
-    <url>
-        <loc>${url}</loc>
-        <lastmod>${currentDate}</lastmod>
-        <changefreq>${page.changefreq}</changefreq>
-        <priority>${page.priority}</priority>
-    </url>`;
-  }).join('');
-
-  return header + urls + footer;
-}
-
-function generateRobotsTxt() {
-  return `User-agent: *
-Allow: /
-
-# Sitemap
-Sitemap: ${baseUrl}/sitemap.xml
-
-# Crawl-delay for respectful crawling
-Crawl-delay: 1
-
-# Allow all common search engines
-User-agent: Googlebot
-Allow: /
-
-User-agent: Bingbot
-Allow: /
-
-User-agent: Slurp
-Allow: /
-
-User-agent: DuckDuckBot
-Allow: /
-
-# Block certain paths if needed
-# Disallow: /temp/
-# Disallow: /private/`;
-}
-
-// Generate files
-const sitemap = generateSitemap();
-const robots = generateRobotsTxt();
-
-// Write files
-const publicDir = path.join(__dirname, '..', 'public');
-if (!fs.existsSync(publicDir)) {
-  fs.mkdirSync(publicDir, { recursive: true });
-}
-
-fs.writeFileSync(path.join(publicDir, 'sitemap.xml'), sitemap);
-fs.writeFileSync(path.join(publicDir, 'robots.txt'), robots);
-
-console.log('✅ Sitemap and robots.txt generated successfully!');
-console.log(`📄 Generated ${pages.length} URLs in sitemap.xml`);
-console.log('🤖 Updated robots.txt with sitemap reference');
-console.log(`📅 Last modified: ${currentDate}`);
-
-// Also log the pages for verification
-console.log('\n📋 Pages included in sitemap:');
-pages.forEach(page => {
-  console.log(`   ${page.path} (Priority: ${page.priority}, ${page.changefreq})`);
-});

package/docs-site/scripts/search-dev.js

@@ -1,112 +0,0 @@
-#!/usr/bin/env node
-
-/**
- * Development utility script for the search index
- * Provides commands for generation, validation, and testing
- */
-
-import { generateSearchIndex, writeSearchIndex } from './generate-search-index.js';
-import fs from 'fs';
-import path from 'path';
-import { fileURLToPath } from 'url';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
-const command = process.argv[2];
-
-switch (command) {
-  case 'generate':
-    console.log('🔄 Generating search index...');
-    try {
-      const index = generateSearchIndex();
-      writeSearchIndex(index);
-    } catch (error) {
-      console.error('❌ Failed to generate search index:', error.message);
-      process.exit(1);
-    }
-    break;
-
-  case 'validate':
-    console.log('✅ Validating search index...');
-    try {
-      const indexPath = path.join(__dirname, '../src/generated-search-index.ts');
-      if (!fs.existsSync(indexPath)) {
-        console.error('❌ Search index file not found. Run "generate" first.');
-        process.exit(1);
-      }
-
-      const stats = fs.statSync(indexPath);
-      const content = fs.readFileSync(indexPath, 'utf-8');
-      const lines = content.split('\n').length;
-      const size = (stats.size / 1024).toFixed(1);
-
-      // Extract the number of entries
-      const match = content.match(/GENERATED_SEARCH_INDEX: SearchableItem\[\] = \[([\s\S]*)\];/);
-      if (match) {
-        const entriesCount = (match[1].match(/\{/g) || []).length;
-        console.log('📊 Search index statistics:');
-        console.log(`   • File size: ${size} KB`);
-        console.log(`   • Lines: ${lines}`);
-        console.log(`   • Search entries: ${entriesCount}`);
-        console.log(`   • Last modified: ${stats.mtime.toLocaleString()}`);
-        console.log('✅ Search index is valid');
-      } else {
-        throw new Error('Invalid search index format');
-      }
-    } catch (error) {
-      console.error('❌ Search index validation failed:', error.message);
-      process.exit(1);
-    }
-    break;
-
-  case 'search': {
-    const query = process.argv[3];
-    if (!query) {
-      console.error('❌ Please provide a search query: npm run search-dev search "your query"');
-      process.exit(1);
-    }
-
-    console.log(`🔍 Testing search for: "${query}"`);
-    try {
-      // Dynamically import and test the search function
-      const { searchDocs } = await import('../utils/search.ts');
-      const results = searchDocs(query);
-
-      if (results.length === 0) {
-        console.log('📭 No results found');
-      } else {
-        console.log(`📋 Found ${results.length} results:`);
-        results.forEach((result, index) => {
-          console.log(`\n${index + 1}. ${result.heading} (${result.pageTitle})`);
-          console.log(`   Path: ${result.path}`);
-          console.log(`   Score: ${result.score}`);
-          console.log(`   Snippet: ${result.snippet.substring(0, 100)}...`);
-        });
-      }
-    } catch (error) {
-      console.error('❌ Search test failed:', error.message);
-      process.exit(1);
-    }
-    break;
-  }
-
-  default:
-    console.log(`
-🔧 Search Index Development Utility
-
-Usage:
-  node scripts/search-dev.js <command>
-
-Commands:
-  generate    Generate the search index from React components
-  validate    Check if the search index is valid and show statistics
-  search      Test search functionality with a query
-
-Examples:
-  node scripts/search-dev.js generate
-  node scripts/search-dev.js validate
-  node scripts/search-dev.js search "pattern matching"
-`);
-    break;
-}