MCP Server Sql Analyzer

🚀 mcp-server-sql-analyzer

An MCP (Model Context Protocol) server that uses SQLGlot to provide SQL analysis, linting, and dialect conversion capabilities.

🚀 Quick Start

The SQLAnalyzer MCP server offers powerful tools for analyzing and processing SQL queries, facilitating the following tasks:

• SQL syntax validation and code inspection
• Conversion of queries between different database dialects (e.g., from MySQL to PostgreSQL)
• Extraction and analysis of table references and dependencies
• Identification of column usage and relationships
• Discovery of supported SQL dialects

How Claude Utilizes This Server

As an AI assistant, this server enhances my ability to handle SQL queries:

1. Syntax Validation: Before suggesting a query to users, I can first validate the SQL syntax to ensure that the provided query is syntactically correct and meets the requirements of the target database dialect.
2. Dialect Conversion: When users need to migrate queries between different database systems, I can accurately perform syntax conversion while maintaining the integrity of the query logic.
3. Code Analysis: Through the analysis of table and column references, I can better understand complex query structures, making it easier to explain how they work and propose optimization suggestions.
4. Compatibility Check: After understanding each database dialect and its specific features, I can guide users to adopt best practices and help avoid issues caused by dialect differences.

These tools enable me to provide more accurate and effective SQL-related support while reducing the risk of syntax errors or dialect compatibility issues.

💡 Usage Tip

Update your personal preferences in the Claude Desktop settings to require generated SQL to be first validated by the lint_sql tool.

✨ Features

1. lint_sql

• Validates SQL query syntax and returns any error messages.
• Input:
  • sql (string): The SQL query to be analyzed.
  • dialect (optional string): The SQL dialect (e.g., 'mysql', 'postgresql').
• Return results include:
  • is_valid (boolean): Whether the query is valid.
  • message (string): Error message or 'No syntax errors'.
  • position (optional object): The line and column where the error occurred.

2. transpile_sql

• Converts queries between different SQL dialects.
• Input:
  • sql (string): The SQL statement to be converted.
  • read_dialect (string): The source SQL dialect.
  • write_dialect (string): The target SQL dialect.
• Return results include:
  • is_valid (boolean): Whether the conversion was successful.
  • message (string): Error message or confirmation of success.
  • sql (string): The converted SQL if the conversion was successful.

3. get_all_table_references

• Extracts table and CTE references from SQL.
• Input:
  • sql (string): The SQL statement to be analyzed.
  • dialect (optional string): The SQL dialect.
• Return results include:
  • is_valid (boolean): Whether the analysis was successful.
  • Information representing all table references.

4. get_all_column_references

• Extracts information about all column references in SQL.
• Input:
  • sql (string): The SQL statement to be analyzed.
  • dialect (optional string): The SQL dialect.
• Return results include:
  • is_valid (boolean): Whether the analysis was successful.
  • Information representing all column references.

📚 Documentation

Resources

• dialects://all: Returns a list of all supported SQL dialects, which is useful for selecting the appropriate dialect for conversion.

Configuration

The project provides two ways to run the MCP server using uvx or uv. You need to add relevant configurations to the claude_desktop_config.json file to integrate with Claude Desktop and obtain enhanced SQL processing capabilities.

Usage Examples:

• Using uvx:

uvx run mcp-server-sql-analyzer --config your_config.json

• Using uv:

uv run mcp-server-sql-analyzer --env-file .env

Development

For developers, the project provides detailed development and testing guides. By cloning the repository and executing the appropriate commands, you can quickly start the development environment.

Running the Server

git clone https://github.com/yourusername/mcp-server-sql-analyzer.git
cd mcp-server-sql-analyzer
uv run start

Testing

The project integrates pytest for unit testing to ensure the stability and reliability of the functions.

uv run pytest .

📄 License

This project is licensed under the MIT License, which allows for free use, modification, and distribution, provided that the original author is cited in derivative works.