Sql Server Agent Modal Context Protocol

🚀 SQL Server Agent - Modal Context Protocol

This project introduces the SQL Server Agent, which enables interaction with SQL Server databases using natural language. It incorporates the Modal Context Protocol (MCP) as an intermediate layer between the LLM (Large Language Model) and the data source.

✨ Features

• Converse with Your Database: Chat with SQL Server in plain English.
• Code-Free Database Operations: Manage all database tasks through natural conversations.
• One-Click Procedure Execution: Effortlessly run stored procedures using natural commands.
• Enhanced Accuracy with MCP: Achieve precise database interactions via the Modal Context Protocol (MCP), which intelligently links your commands with data.
• Context-Aware Conversations: Enjoy seamless interactions powered by the Modal Context Protocol.

📚 What is MCP?

MCP (Modal Context Protocol) is a methodology that explains how to bind context to an LLM. It offers a standardized way to connect AI models with different data sources and tools.

🤔 Why Choose MCP?

MCP helps us construct complex processes in a simplified manner. It allows us to build agents on top of it, where language models need to be frequently integrated with data sources and tools.

🔧 MCP Architecture

The MCP architecture follows the client - server model, enabling a single client to interact seamlessly with multiple servers.

• MCP - Client: Your AI client (LLM) accesses data.
• MCP - Protocol: Connects your client directly to the server.
• MCP - Server: Assists your client in accessing data sources via MCP.
• Local Databases, Cloud Databases, External APIs: Provide data through local storage, cloud, or online APIs.

🚀 Dive into the Implementation

After understanding MCP and its architecture, let's integrate it all with the SQL Server Agent.

🤖 What is SQL Server Agent?

SQL Server Agent is a conversational AI query CLI (Command - Line Interface) that allows you to interact with your SQL Server database using natural language. Powered by the Modal Context Protocol, it acts as an intelligent layer between the LLM and the database, making it possible to:

• Query the database without using SQL.
• Execute stored procedures through conversational commands.
• Perform complex operations while maintaining context across multiple steps.

Whether you're a developer, analyst, or non - technical person, this agent makes your data accessible through intuitive, human - like interactions.

Now, let's get started with the following steps 👇

📋 Prerequisites

Before you start, make sure the following are installed:

• Python 3.12+ is installed on your computer.
• You have a valid OpenAI API key.

🚀 Quick Start

Follow these steps to launch the project:

1. Clone the Repository

git clone https://github.com/Amanp17/mcp-sql-server-natural-lang.git
cd mcp-sql-server-natural-lang

2. Install Dependencies

pip install -r requirements.txt

3. Set Environment Variables

Create a .env file in the root directory of the project and add the following content:

OPENAI_API_KEY=your_openai_api_key
MSSQL_SERVER=localhost
MSSQL_DATABASE=your_database_name
MSSQL_USERNAME=your_username
MSSQL_PASSWORD=your_password
MSSQL_DRIVER={ODBC Driver 17 for SQL Server}

💻 Run SQL Server Agent

After setting up the environment and dependencies, you can interact with the SQL Server Agent:

4. Run the Agent

Run the following command to start the agent:

python agent.py

Ensure that the agent.py file exists in the project directory. After starting, you will see output similar to the following:

SQL Server Agent is listening...
Waiting for connections...

🧪 Test the Agent

To test the agent, open another terminal window and run the following command:

curl http://localhost:5000/ping

The response should be:

pong

This indicates that the agent is working properly.

5. Configure the Agent (Optional)

You can customize the behavior of the agent in the config.json file. Here are the possible configuration options:

Database Configuration

{
  "database": {
    "server": "localhost",
    "database": "your_database_name",
    "username": "your_username",
    "password": "your_password"
  },
  "odbc_driver": "{ODBC Driver 17 for SQL Server}"
}

OpenAI Configuration

{
  "openai": {
    "api_key": "your_openai_api_key",
    "model": "gpt-3.5-turbo"
  }
}

You can adjust these settings as needed.

📝 Conclusion

The SQL Server Agent provides a powerful and convenient way to interact with databases using natural language. Combined with the power of the Modal Context Protocol, it can understand complex queries and generate corresponding database operations. In the future, as AI technology continues to advance, the SQL Server Agent will become more intelligent and feature - rich, bringing new possibilities to database management.