Workspace Db Manager

🚀 ワークスペースデータベースマネージャ

TypeScriptをベースにしたMCP（モデルコンテキストプロトコル）サーバーで、ファイルシステムを通じてワークスペースデータベースを統合管理します。

🚀 クイックスタート

1. 依存関係をインストールします：

npm install

2. TypeScriptコードをビルドします：

npm run build

3. コアデータベースを初期化します：

npm run init-db

4. サーバーを起動します：

npm start

✨ 主な機能

• SQLiteデータベースを自動検出します。
• データベースの変更を検出するために、ファイルシステムをリアルタイムで監視します。
• データベース接続プールと管理機能を提供します。
• データベースの状態を自動的に追跡して更新します。
• クロスデータベース操作をサポートします。
• TypeScript/ESモジュールベースのアーキテクチャを採用しています。

📦 インストール

開発環境でのインストール

# 開発モードで実行し、自動リロードをサポートします
npm run dev

# テストを実行します
npm test

# TypeScriptコードをビルドします
npm run build

📚 ドキュメント

継続的インテグレーション

このプロジェクトはGitHub Actionsを使用して継続的インテグレーションを行っています：

• Node.js 20.x、21.x、および22.xで動作します。
• すべてのプッシュとプルリクエストで自動的にテストを実行します。
• TypeScriptのコンパイル状況をチェックします。
• テストカバレッジレポートを生成してアップロードします。
• コード品質基準を満たさない場合は失敗します。

設定

サーバーはWorkspaceConfigオブジェクトを通じて設定できます：

const manager = new WorkspaceDBManager({
    watchPaths: ['/path/to/workspace'],
    pollInterval: 1000, // オプション：ファイルシステムのポーリング間隔
    database: {
        verbose: true // オプション：詳細なデータベースログ記録を有効にする
    }
});

💻 使用例

基本的な使用法

自動データベース検出

サーバーは自動的に以下を検出して追跡します：

• 新しいデータベースファイル
• データベースの変更
• データベースの削除

データベース管理

// すべての管理対象データベースをリストします
const databases = await manager.listManagedDatabases();

// システム設定を取得します
const config = await manager.getConfig('some_key');

イベント

サーバーはさまざまな操作のイベントを発行します：

• database-added：新しいデータベースが検出されたときにトリガーされます。
• database-changed：データベースが変更されたときにトリガーされます。
• database-removed：データベースが削除されたときにトリガーされます。
• error：エラーが発生したときにトリガーされます。
• initialized：サーバーが完全に初期化された後にトリガーされます。

高度な使用法

# すべてのテストを実行します
npm test

# カバレッジを伴ってテストを実行します
npm test -- --coverage

🤝 貢献方法

1. リポジトリをフォークします。
2. 機能ブランチを作成します。
3. 変更をコミットします。
4. ブランチにプッシュします。
5. プルリクエストを作成します。

📄 ライセンス

ISC