# π SQL Server MCP Documentation
Welcome to the comprehensive documentation for the SQL Server MCP (Model Context Protocol) server. This directory
contains all the detailed documentation for understanding, setting up, and using this enterprise-grade database
integration tool.
## π Quick Start Guides
Perfect for getting up and running quickly:
- **[Quick Start - Warp Terminal](QUICKSTART.md)** - 5-minute setup for Warp Terminal
- **[Quick Start - VS Code](QUICKSTART-VSCODE.md)** - 5-minute setup for GitHub Copilot in VS Code
- **[Warp Setup Guide](WARP_SETUP_GUIDE.md)** - Detailed Warp Terminal configuration
## ποΈ Core Documentation
Essential technical documentation:
- **[Architecture Guide](ARCHITECTURE.md)** - Technical deep-dive and system design
- **[Security Guide](SECURITY.md)** - Comprehensive security configuration and threat model
- **[Integration Test Changes](INTEGRATION-TEST-CHANGES.md)** - Testing methodology and validation
## βοΈ Cloud & Integration Guides
Enterprise deployment and integration:
- **[AWS Secrets Manager Guide](AWS-SECRETS-GUIDE.md)** - Enterprise credential management
- **[Azure Key Vault Guide](AZURE-SECRETS-GUIDE.md)** - Cloud secret management setup
- **[VS Code Integration Guide](VSCODE-INTEGRATION-GUIDE.md)** - Advanced workflows and configuration
## π οΈ Development & Operations
For developers and system administrators:
- **[Performance Guide](PERFORMANCE.md)** - Performance monitoring, benchmarks, and optimization
- **[Debug Logging Guide](DEBUG-LOGGING.md)** - Troubleshooting and debugging
- **[Smoke Test Guide](SMOKE-TEST-GUIDE.md)** - Validation and testing procedures
- **[System Maintenance Guide](MAINTENANCE.md)** - Process cleanup, resource management, and system optimization
- **[Release Token Setup](RELEASE-TOKEN-SETUP.md)** - CI/CD and release configuration
## π€ DevOps & Automation
Automated workflows and processes:
- **[Dependabot Auto-Triage](DEPENDABOT-AUTO-TRIAGE.md)** - Dependency management automation
- **[Git Commit Checklist](GIT-COMMIT-CHECKLIST.md)** - Pre-commit quality gates and guidelines
- **[Git Push Checklist](GIT-PUSH-CHECKLIST.md)** - Pre-push validation and deployment guidelines
- **[Quality No-Compromise Case Study](QUALITY-NO-COMPROMISE.md)** - Real-world analysis of zero-tolerance quality standards
## π API Documentation
Complete reference materials:
- **[API Tools Reference](tools.html)** - Complete MCP tools documentation (16 tools)
- **[Documentation Site](index.html)** - Generated documentation landing page
## π Documentation Organization
This documentation is organized into several categories:
### **User Guides** π―
Focus on getting users productive quickly with clear setup instructions and common use cases.
### **Technical Documentation** βοΈ
Deep technical content for developers, system architects, and advanced users.
### **Cloud Integration** βοΈ
Enterprise deployment patterns, cloud services integration, and production considerations.
### **Development Resources** π οΈ
Materials for contributors, maintainers, and those extending the system.
### **API Reference** π
Complete technical specifications for all MCP tools and interfaces.
## π External Resources
- **[Main Project Repository](https://github.com/egarcia74/warp-sql-server-mcp)** - Source code and issues
- **[Live Documentation Site](https://egarcia74.github.io/warp-sql-server-mcp/)** - Always up-to-date web documentation
- **[Complete API Tools Reference](https://egarcia74.github.io/warp-sql-server-mcp/tools.html)** - Interactive API documentation
## π€ Contributing
Found an issue with the documentation or want to contribute?
1. Check the [main project README](../README.md) for contribution guidelines
2. Review the [Testing Guide](../test/README.md) for comprehensive test documentation
3. See the [Contributing Guide](../CONTRIBUTING.md) for development workflow
## π Documentation Maintenance
This documentation index is maintained alongside the codebase. When adding new documentation:
1. Add the new file to the appropriate section above
2. Include a brief, helpful description
3. Update any cross-references as needed
4. Test all links for accuracy
---
**π‘ Quick Navigation**:
- [Back to Main README](../README.md)
- [View All Files in This Directory](.)
- [Project Overview](../WARP.md)