Pysqlitmcp

🚀 PySqlitMCP

PySqlitMCPは、FastMCPフレームワークとPySqlitライブラリに基づくデータベース操作ツールセットです。SQLiteデータベースの完全な管理機能を提供し、データベースの作成、テーブル操作、データの追加・削除・更新・検索、バックアップ・復元、データのインポート・エクスポートなどの機能が含まれています。

✨ 主な機能

データベース管理

• 新しいデータベースを作成する
• データベースの詳細情報を取得する
• データベースを指定されたファイルにバックアップする
• バックアップファイルからデータベースを復元する
• すべてのバックアップファイルをリストする

テーブル操作

• 新しいデータテーブルを作成する
• 指定されたデータテーブルを削除する
• 指定されたテーブルの詳細情報を取得する
• テーブル内のレコードの総数をカウントする
• データベース内のすべてのテーブルをリストする

データ操作

• テーブルに単一のデータを挿入する
• テーブルに大量のデータを一括挿入する
• テーブル内のデータを検索する
• テーブル内のデータを更新する
• テーブル内のデータを削除する
• カスタムSQL文を実行する

データのインポート・エクスポート

• CSVファイルからテーブルにデータをインポートする
• テーブルのデータをCSVファイルにエクスポートする

📦 インストール

pipを使用したインストール

uv pip install -r requirements.txt

uvを使用したインストール（推奨）

uv sync

🚀 クイックスタート

1. すべての依存関係がインストールされていることを確認する
2. メインプログラムを実行する：

   python main.py
   

📚 ドキュメント

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 ファイルを参照してください。