Smart Code Search MCP Server

# SCS-MCP Documentation Welcome to the Smart Code Search MCP Server documentation. This directory contains comprehensive guides and references for using and extending SCS-MCP. ## 📚 Documentation Index ### Getting Started - **[Installation Guide](INSTALLATION.md)** - Step-by-step installation instructions - **[Features Overview](FEATURES.md)** - Complete feature documentation - **[API Reference](API.md)** - MCP tool API documentation ### Core Guides - **[Architecture Overview](ARCHITECTURE.md)** - System design and components - **[Graph Visualization](GRAPH_VISUALIZATION.md)** - Creating and using dependency graphs - **[Media Server](MEDIA_SERVER.md)** - Screenshot and recording capabilities ### Voice Assistant - **[Voice Assistant Setup](voice-assistant/README.md)** - Voice interface configuration - **[Voice Commands](voice-assistant/COMMANDS.md)** - Complete command reference - **[VS Code Integration](voice-assistant/VSCODE.md)** - Editor integration guide - **[Media Capture Guide](MEDIA_SERVER.md)** - Screenshots and recordings ### Development - **[Development Guide](development/SETUP.md)** - Setting up development environment - **[Testing Guide](development/TESTING.md)** - Running and writing tests - **[Contributing](../CONTRIBUTING.md)** - Contribution guidelines ## 🚀 Quick Links ### Most Popular Guides 1. [How to Generate Dependency Graphs](GRAPH_VISUALIZATION.md#quick-start) 2. [Setting Up Voice Commands](voice-assistant/README.md) 3. [Understanding the Architecture](ARCHITECTURE.md) 4. [API Quick Reference](API.md#table-of-contents) ### Common Tasks - [Configure Claude Desktop](INSTALLATION.md#claude-desktop-configuration) - [Create a Mermaid Diagram](GRAPH_VISUALIZATION.md#1-mermaid-format) - [Detect Circular Dependencies](GRAPH_VISUALIZATION.md#circular-dependency-detection) - [Set Up Testing](development/TESTING.md) ## 📖 Reading Order For new users, we recommend reading the documentation in this order: 1. **[Installation Guide](INSTALLATION.md)** - Get SCS-MCP running 2. **[Features Overview](FEATURES.md)** - Understand capabilities 3. **[API Reference](API.md)** - Learn the tools 4. **[Graph Visualization](GRAPH_VISUALIZATION.md)** - Visualize your code 5. **[Architecture Overview](ARCHITECTURE.md)** - Understand the internals ## 🔍 Finding Information ### By Topic **Search and Analysis** - [Semantic Search](FEATURES.md#semantic-search) - [Code Analysis](FEATURES.md#code-analysis) - [Symbol Analysis](API.md#3-analyze_symbol) **Visualization** - [Graph Types](GRAPH_VISUALIZATION.md#graph-types) - [Output Formats](GRAPH_VISUALIZATION.md#output-formats) - [Circular Dependencies](GRAPH_VISUALIZATION.md#circular-dependency-detection) **Integration** - [Claude Desktop Setup](INSTALLATION.md#claude-desktop-configuration) - [VS Code Extension](voice-assistant/VSCODE.md) - [CI/CD Integration](GRAPH_VISUALIZATION.md#github-actions) **Development** - [Testing](development/TESTING.md) - [Contributing](../CONTRIBUTING.md) - [Architecture](ARCHITECTURE.md) ### By User Role **For Users** - Start with [Installation](INSTALLATION.md) - Learn [Features](FEATURES.md) - Reference [API](API.md) **For Developers** - Read [Architecture](ARCHITECTURE.md) - Set up [Development Environment](development/SETUP.md) - Understand [Testing](development/TESTING.md) **For Contributors** - Review [Contributing Guidelines](../CONTRIBUTING.md) - Understand [Architecture](ARCHITECTURE.md) - Check [Development Setup](development/SETUP.md) ## 📝 Documentation Standards All documentation in this project follows these standards: - **Markdown Format**: All docs use GitHub-flavored markdown - **Code Examples**: Include practical, runnable examples - **Visual Aids**: Use diagrams and screenshots where helpful - **Cross-References**: Link between related documents - **Versioning**: Document version-specific features ## 🤝 Contributing to Documentation We welcome documentation improvements! See our [Contributing Guide](../CONTRIBUTING.md#documentation) for: - Documentation style guide - How to submit documentation PRs - Building documentation locally - Translation guidelines ## 📬 Getting Help If you can't find what you need: 1. Search the documentation using GitHub's search 2. Check the [FAQ](FAQ.md) (coming soon) 3. Open a [Discussion](https://github.com/StevenJJobson/scs-mcp/discussions) 4. Report documentation issues in [Issues](https://github.com/StevenJJobson/scs-mcp/issues) ## 🔄 Recent Updates - **Graph Visualization Guide** - Complete guide for dependency graphs - **Features Overview** - Comprehensive feature documentation - **API Reference** - Added new graph generation tool - **Architecture Guide** - Updated with latest components --- *Last updated: January 2025* *Documentation version: 1.0.1*