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. 創建Pull Request

📄 許可證

ISC