<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Warp SQL Server MCP - Documentation</title>
<style>
body {
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen, Ubuntu, Cantarell, sans-serif;
line-height: 1.6;
max-width: 1200px;
margin: 0 auto;
padding: 2rem;
color: #333;
}
.header {
text-align: center;
margin-bottom: 3rem;
padding: 2rem;
background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
color: white;
border-radius: 8px;
}
.grid {
display: grid;
grid-template-columns: repeat(auto-fit, minmax(300px, 1fr));
gap: 2rem;
margin: 2rem 0;
}
.card {
background: #f8f9fa;
padding: 1.5rem;
border-radius: 8px;
border: 1px solid #e9ecef;
transition: transform 0.2s ease;
}
.card:hover {
transform: translateY(-2px);
box-shadow: 0 4px 12px rgba(0,0,0,0.1);
}
.card h3 {
margin-top: 0;
color: #495057;
}
.card p {
color: #6c757d;
}
.card a {
color: #007bff;
text-decoration: none;
font-weight: 500;
}
.card a:hover {
text-decoration: underline;
}
.badge {
display: inline-block;
padding: 0.25rem 0.5rem;
background: #28a745;
color: white;
border-radius: 3px;
font-size: 0.75rem;
margin: 0.25rem;
}
.code {
background: #f1f3f4;
padding: 0.2rem 0.4rem;
border-radius: 3px;
font-family: 'Monaco', 'Consolas', monospace;
font-size: 0.9em;
}
.tools-preview {
max-height: 200px;
overflow-y: auto;
border: 1px solid #e9ecef;
border-radius: 5px;
padding: 1rem;
margin: 1rem 0;
}
.tools-preview ul {
margin: 0;
padding-left: 1.2rem;
}
.tools-preview li {
margin-bottom: 0.3rem;
}
</style>
</head>
<body>
<div class="header">
<h1>ποΈ Warp SQL Server MCP</h1>
<p>Model Context Protocol server for SQL Server integration with Warp terminal</p>
<div>
<span class="badge">v1.7.12</span>
<span class="badge">Node.js 18+</span>
<span class="badge">MCP</span>
<span class="badge">SQL Server</span>
<span class="badge">16 Tools</span>
</div>
</div>
<div class="grid">
<div class="card">
<h3>π Documentation</h3>
<p>Complete setup guides, installation instructions, and usage examples.</p>
<a href="https://github.com/egarcia74/warp-sql-server-mcp#readme">π README β</a>
<br><br>
<a href="https://github.com/egarcia74/warp-sql-server-mcp/blob/main/docs/QUICKSTART.md">π₯οΈ Warp Quick Start β</a>
<br><br>
<a href="https://github.com/egarcia74/warp-sql-server-mcp/blob/main/docs/QUICKSTART-VSCODE.md">π» VS Code Quick Start β</a>
</div>
<div class="card">
<h3>π Latest Release</h3>
<p>Download the latest version and view the changelog.</p>
<a href="https://github.com/egarcia74/warp-sql-server-mcp/releases/latest">Download v1.7.12 β</a>
</div>
<div class="card">
<h3>π§ͺ Test Coverage</h3>
<p>View detailed test coverage reports and test results.</p>
<a href="./coverage/index.html">Coverage Report β</a>
</div>
<div class="card">
<h3>π οΈ MCP Tools Reference</h3>
<p>Comprehensive documentation for all 16 available MCP tools with parameters, examples, and usage details.</p>
<a href="./tools.html">View Full API Documentation β</a>
</div>
<div class="card">
<h3>π Available Tools</h3>
<p>Quick overview of MCP tools provided by this server:</p>
<div class="tools-preview">
<ul>
<li><span class="code">executeQuery</span> - Execute a SQL query on the connected SQL Server database</li>
<li><span class="code">listDatabases</span> - List all databases on the SQL Server instance</li>
<li><span class="code">listTables</span> - List all tables in a specific database</li>
<li><span class="code">describeTable</span> - Get the schema information for a specific table</li>
<li><span class="code">listForeignKeys</span> - List all foreign key relationships in a schema</li>
<li><span class="code">getTableData</span> - Get sample data from a table with optional filtering and limiting</li>
<li><span class="code">exportTableCsv</span> - Export table data in CSV format</li>
<li><span class="code">getPerformanceStats</span> - Get overall performance statistics and health summary</li>
<li><span class="code">getQueryPerformance</span> - Get detailed query performance breakdown by tool</li>
<li><span class="code">getConnectionHealth</span> - Get connection pool health metrics and diagnostics</li>
<li><span class="code">explainQuery</span> - Get the execution plan for a SQL query to analyze performance</li>
<li><span class="code">analyzeQueryPerformance</span> - Analyze query performance and provide optimization suggestions</li>
<li><span class="code">getIndexRecommendations</span> - Get index recommendations for database optimization</li>
<li><span class="code">detectQueryBottlenecks</span> - Detect and analyze query bottlenecks in the database</li>
<li><span class="code">getOptimizationInsights</span> - Get comprehensive database optimization insights and health analysis</li>
<li><span class="code">getServerInfo</span> - Get MCP server configuration, status, and logging information</li>
</ul>
</div>
<a href="./tools.html">View detailed documentation β</a>
</div>
<div class="card">
<h3>βοΈ Configuration</h3>
<p>Environment variables and configuration options:</p>
<ul>
<li><span class="code">SQL_SERVER_HOST</span> - SQL Server hostname</li>
<li><span class="code">SQL_SERVER_PORT</span> - SQL Server port (default: 1433)</li>
<li><span class="code">SQL_SERVER_DATABASE</span> - Initial database (default: master)</li>
<li><span class="code">SQL_SERVER_USER</span> - SQL Server username (optional)</li>
<li><span class="code">SQL_SERVER_PASSWORD</span> - SQL Server password (optional)</li>
<li><span class="code">SQL_SERVER_ENCRYPT</span> - Enable encryption (default: false)</li>
<li><span class="code">SQL_SERVER_TRUST_CERT</span> - Trust server certificate (default: true)</li>
<li><span class="code">SQL_SERVER_READ_ONLY</span> - Read-only mode (default: true)</li>
<li><span class="code">SQL_SERVER_ALLOW_DESTRUCTIVE_OPERATIONS</span> - Allow INSERT/UPDATE/DELETE (default: false)</li>
<li><span class="code">SQL_SERVER_ALLOW_SCHEMA_CHANGES</span> - Allow CREATE/DROP/ALTER (default: false)</li>
<li><span class="code">ENABLE_PERFORMANCE_MONITORING</span> - Enable query performance tracking (default: true)</li>
<li><span class="code">MAX_METRICS_HISTORY</span> - Maximum performance records to retain (default: 1000)</li>
<li><span class="code">SLOW_QUERY_THRESHOLD</span> - Milliseconds to flag slow queries (default: 5000)</li>
<li><span class="code">TRACK_POOL_METRICS</span> - Enable connection pool monitoring (default: true)</li>
<li><span class="code">PERFORMANCE_SAMPLING_RATE</span> - Fraction of queries to monitor (default: 1.0)</li>
</ul>
</div>
<div class="card">
<h3>π Links</h3>
<p>Useful resources and links:</p>
<ul>
<li><a href="https://github.com/egarcia74/warp-sql-server-mcp">GitHub Repository</a></li>
<li><a href="https://github.com/egarcia74/warp-sql-server-mcp/issues">Report Issues</a></li>
<li><a href="https://modelcontextprotocol.io/docs">MCP Documentation</a></li>
<li><a href="https://www.warp.dev/">Warp Terminal</a></li>
</ul>
</div>
</div>
<footer style="margin-top: 3rem; text-align: center; color: #6c757d; border-top: 1px solid #e9ecef; padding-top: 1rem;">
<p>Built with β€οΈ for the MCP ecosystem | Documentation generated automatically</p>
</footer>
</body>
</html>