Pysqlitmcp

🚀 PySqlitMCP

PySqlitMCP 是一款基於 FastMCP 框架和 PySqlit 庫的數據庫操作工具集。它具備完整的 SQLite 數據庫管理功能，涵蓋數據庫創建、表操作、數據增刪改查、備份恢復以及數據導入導出等。

🚀 快速開始

1. 確保已安裝所有依賴
2. 運行主程序：

   python main.py
   

✨ 主要特性

數據庫管理

• 創建新的數據庫
• 獲取數據庫詳細信息
• 備份數據庫到指定文件
• 從備份文件恢復數據庫
• 列出所有備份文件

表操作

• 創建新的數據表
• 刪除指定的數據表
• 獲取指定表的詳細信息
• 統計表中的記錄總數
• 列出數據庫中的所有表

數據操作

• 向表中插入單條數據
• 向表中批量插入數據
• 查詢表中的數據
• 更新表中的數據
• 刪除表中的數據
• 執行自定義 SQL 語句

數據導入導出

• 從 CSV 文件導入數據到表
• 將表數據導出到 CSV 文件

📦 安裝指南

使用 pip 安裝

uv pip install -r requirements.txt

使用 uv 安裝（推薦）

uv sync

📚 詳細文檔

使用指南

1. 操作前先獲取數據庫信息瞭解結構
2. 表操作前檢查表是否存在
3. 數據操作注意數據類型匹配
4. 大量數據使用批量操作
5. 重要操作前備份數據庫
6. 自定義 SQL 語句謹慎執行，避免誤操作，優先使用封裝好的方法
7. 創建數據庫時可以指定保存路徑
8. 導入導出數據時可以指定文件路徑
9. 批量操作時請務必檢查數據格式和數量，避免錯誤操作
10. 如果提供的參數或者格式有錯誤，請自動提示錯誤信息，並給出正確的使用方法
11. 不要擅自對數據庫表操作
12. 動態使用提示詞根據傳入的參數給出提示

API 接口說明

數據庫管理接口

create_database(db_name="test", db_path=None)

創建一個新的數據庫

參數：

• db_name (str, optional): 要創建的數據庫名，默認為 "test"
• db_path (str, optional): 數據庫文件保存的完整路徑，如果未提供，則使用當前工作目錄

返回：

• 數據庫文件的完整路徑

get_database_info()

獲取數據庫詳細信息

返回：

• 包含數據庫詳細信息的字典，包括：
  • path: 數據庫文件路徑
  • tables: 表列表及其結構信息
  • table_count: 表的數量

backup_database(backup_file)

備份數據庫到指定文件

參數：

• backup_file (str): 備份文件路徑

返回：

• 成功返回 True，失敗返回 False

restore_database(backup_file)

從備份文件恢復數據庫

參數：

• backup_file (str): 備份文件路徑

返回：

• 成功返回 True，失敗返回 False

list_backup_files()

列出所有備份文件

返回：

• 備份文件信息列表，每個元素包含文件名和創建時間

表操作接口

create_tables(table_name, columnss, pk=None, unique=None, check=None)

創建新的數據表

參數：

• table_name (str): 要創建的表名
• columnss (list): 列定義列表
• pk (str/list, optional): 主鍵列名或主鍵列名列表
• unique (list, optional): 唯一約束列名列表
• check (str, optional): 檢查約束條件

返回：

• 創建成功返回 True，失敗返回 False

drop_tables(table_name)

刪除指定的數據表

參數：

• table_name (str): 要刪除的表名

返回：

• 刪除成功返回 True，失敗返回 False

get_table_info(table_name)

獲取指定表的詳細信息

參數：

• table_name (str): 要查詢的表名

返回：

• 包含表結構的字典

list_tables()

列出數據庫中的所有表

返回：

• 表名列表

get_table_count(table_name)

統計表中的記錄總數

參數：

• table_name (str): 要統計的表名

返回：

• 表中的記錄總數

數據操作接口

insert_data(table_name, data)

向表中插入單條數據

參數：

• table_name (str): 目標表名
• data (dict): 要插入的數據

返回：

• 成功插入返回新記錄的 ID，失敗返回 -1

insert_multiple_data(table_name, datas)

向表中批量插入數據

參數：

• table_name (str): 目標表名
• datas (list): 要插入的數據列表

返回：

• 成功插入的記錄數量

select_data(table_name, condition=None)

查詢表中的數據

參數：

• table_name (str): 要查詢的表名
• condition (str, optional): WHERE 條件語句

返回：

• 查詢結果列表

update_data(table_name, data, condition)

更新表中的數據

參數：

• table_name (str): 目標表名
• data (dict): 要更新的數據
• condition (str): WHERE 條件語句

返回：

• 成功更新的記錄數量

delete_data(table_name, condition)

刪除表中的數據

參數：

• table_name (str): 目標表名
• condition (str): WHERE 條件語句

返回：

• 成功刪除的記錄數量

execute_sql_statement(sql)

執行自定義 SQL 語句

參數：

• sql (str): 要執行的 SQL 語句

返回：

• 查詢結果列表（對於 SELECT 語句）或受影響的行數（對於 INSERT/UPDATE/DELETE 語句）

數據導入導出接口

import_from_csv(table_name, import_file)

從 CSV 文件導入數據到表

參數：

• table_name (str): 目標表名
• import_file (str): 要導入的 CSV 文件路徑

返回：

• 成功導入的記錄數量

export_to_csv(table_name, export_file)

將表數據導出到 CSV 文件

參數：

• table_name (str): 要導出的表名
• export_file (str): 導出的 CSV 文件路徑

返回：

• 導出成功返回 True，失敗返回 False

🔧 技術細節

• Python >= 3.11
• FastMCP >= 2.12.2
• PySqlit >= 0.2.2

📄 許可證

本項目採用 MIT 許可證。詳情請見 LICENSE 文件。