Skip to content

README.md

Latest commit

 

History

History
83 lines (55 loc) · 3.82 KB

README.md

File metadata and controls

83 lines (55 loc) · 3.82 KB

Gemini CLI Extension - SQL Server

Note

This extension is currently in beta (pre-v1.0), and may see breaking changes until the first stable release (v1.0).

This Gemini CLI extension provides a set of tools to interact with Microsoft SQL Server instances. It allows you to manage your databases, execute queries, and explore schemas directly from the Gemini CLI, using natural language prompts.

Learn more about Gemini CLI Extensions.

Why Use the SQL Server Extension?

  • Natural Language Management: Stop wrestling with complex commands. Explore schemas and query data by describing what you want in plain English.
  • Seamless Workflow: As a Google-developed extension, it integrates seamlessly into the Gemini CLI environment. No need to constantly switch contexts for common database tasks.
  • Code Generation: Accelerate development by asking Gemini to generate data classes and other code snippets based on your table schemas.

Prerequisites

Before you begin, ensure you have the following:

  • Gemini CLI installed with version +v0.6.0.
  • A running SQL Server instance.
  • A user with database-level permissions to execute queries.

Getting Started

Installation

To install the extension, use the command:

gemini extensions install https://github.com/gemini-cli-extensions/sql-server

Configuration

Set the following environment variables before starting the Gemini CLI:

  • MSSQL_HOST: The hostname or IP address of the SQL Server.
  • MSSQL_PORT: The port number of the SQL Server.
  • MSSQL_DATABASE: The name of the database to connect to.
  • MSSQL_USER: The username for authentication.
  • MSSQL_PASSWORD: The password for authentication.

Start Gemini CLI

To start the Gemini CLI, use the following command:

gemini

Warning

Changing Instance & Database Connections Currently, the database connection must be configured before starting the Gemini CLI and can not be changed during a session. To save and resume conversation history use command: /chat save <tag> and /chat resume <tag>.

Usage Examples

Interact with SQl Server using natural language right from your IDE:

  • Explore Schemas and Data:
    • "Show me all tables in the 'orders' database."
    • "What are the columns in the 'products' table?"
    • "How many orders were placed in the last 30 days, and what were the top 5 most purchased items?"
  • Generate Code:
    • "Generate a Python dataclass to represent the 'customers' table."

Supported Tools

  • list_tables: lists schema information for all or specified tables in a SQL server database.
  • execute_sql: executes a SQL statement against a SQL Server database.

Additional Extensions

Find additional extensions to support your entire software development lifecycle at github.com/gemini-cli-extensions, including:

Troubleshooting

  • "✖ Error during discovery for server: MCP error -32000: Connection closed": The database connection has not been established. Ensure your configuration is set via environment variables.
  • "✖ MCP ERROR: Error: spawn /Users//.gemini/extensions/sql-server/toolbox ENOENT": The Toolbox binary did not download correctly. Ensure you are using Gemini CLI v0.6.0+.
  • "cannot execute binary file": The Toolbox binary did not download correctly. Ensure the correct binary for your OS/Architecture has been downloaded. See Installing the server for more information.