Sql MCP Server

🚀 快速MCP SQL Server

快速MCP SQL Server是一個強大的工具，它藉助對話式AI界面，為用戶提供與SQL數據庫交互的便捷途徑。用戶能夠通過自然語言與數據庫進行交互，輕鬆執行各類操作。

🚀 快速開始

快速MCP SQL Server允許用戶通過對話式AI界面與Microsoft SQL Server進行交互。它使用FastMCP框架，提供了查詢和操作SQL數據的工具，讓用戶可以用自然語言與數據庫進行交互。

✨ 主要特性

• 執行SQL查詢並查看結果
• 列出數據庫中的可用表
• 描述表結構及其列信息
• 執行非查詢操作（INSERT, UPDATE, DELETE）
• 列出系統上安裝的ODBC驅動程序
• 查看數據庫信息和服務器詳細信息

📦 安裝指南

安裝Python依賴項

pip install pyodbc asyncio fastmcp

安裝數據庫及驅動

確保安裝了Microsoft SQL Server以及ODBC Driver 17 for SQL Server。

配置連接參數

在腳本中配置連接參數：

# 連接參數
SERVER = "server\\instance"  # 更改為您的SQL Server實例
DATABASE = "db_name"              # 更改為您的數據庫名稱

💻 使用示例

基礎用法

運行服務器：

python mcp_sql_server.py

服務器將初始化並連接到指定的SQL Server數據庫。

高級用法

執行SQL查詢

# 執行SQL查詢並返回結果
query_sql(query: str = None) -> str

• 如果未提供查詢，則默認為 SELECT * FROM [dbo].[Table_1]
• 返回格式化字符串形式的結果

列出數據庫中的所有表

# 列出數據庫中的所有表
list_tables() -> str

• 返回表格名稱的列表作為字符串

獲取特定表的結構

# 獲取特定表的結構
describe_table(table_name: str) -> str

• table_name: 要描述的表名
• 返回包括列名和數據類型的信息

執行非查詢操作

# 執行INSERT, UPDATE, DELETE或其他非查詢SQL語句
execute_nonquery(sql: str) -> str

• sql: 要執行的SQL語句
• 返回操作結果，包括受影響行數
• 自動處理事務（提交/回滾）

列出系統上安裝的所有ODBC驅動程序

# 列出系統上安裝的所有ODBC驅動程序
list_odbc_drivers() -> str

• 返回逗號分隔的已安裝ODBC驅動程序列表

獲取所連接數據庫的基本信息

# 獲取所連接數據庫的基本信息
database_info() -> str

• 返回數據庫版本和配置信息

🔧 技術細節

服務器使用異步編程庫asyncio，結合FastMCP框架實現高效通信。數據查詢通過pyodbc執行，並與數據庫建立連接池以優化性能。所有數據庫操作都封裝在try-except塊中，捕獲異常並返回用戶友好的錯誤消息。

📚 詳細文檔

自定義

要擴展功能，可以添加新的工具到tools.py文件，並註冊到main.py的命令字典中。

安全注意事項

• 數據庫連接使用SSL加密
• 默認禁用遠程訪問
• 支持身份驗證插件擴展

常見問題排查

無法連接數據庫

檢查以下幾點：

1. 確保數據庫服務已運行
2. 檢查防火牆設置是否允許連接
3. 驗證提供的憑據是否正確

安裝依賴失敗

確保使用Python 3.7或更高版本，並在安裝過程中保持網絡連接。

📄 許可證

項目遵循MIT許可證，詳細信息請參閱LICENSE文件。

📞 聯繫方式

如需反饋或技術支持，請訪問項目GitHub倉庫或聯繫維護人員。