Workspace Db Manager

🚀 Workspace Database Manager

A TypeScript-based MCP (Model Context Protocol) server for integrated management of workspace databases through the file system.

🚀 Quick Start

1. Install dependencies:

npm install

2. Build the TypeScript code:

npm run build

3. Initialize the core database:

npm run init-db

4. Start the server:

npm start

✨ Features

• Automatic discovery of SQLite databases
• Real-time file system monitoring to detect database changes
• Database connection pooling and management capabilities
• Automatic tracking and updating of database status
• Support for cross-database operations
• Architecture based on TypeScript/ES modules

📦 Installation

The installation steps are included in the Quick Start section above.

💻 Usage Examples

Basic Usage

// Configuration example
const manager = new WorkspaceDBManager({
    watchPaths: ['/path/to/workspace'],
    pollInterval: 1000, // Optional: File system polling interval
    database: {
        verbose: true // Optional: Enable detailed database logging
    }
});

Advanced Usage

// List all managed databases
const databases = await manager.listManagedDatabases();

// Get system configuration
const config = await manager.getConfig('some_key');

📚 Documentation

Database Operations

Automatic Database Discovery

The server automatically detects and tracks:

• New database files
• Database modifications
• Database removals

Database Management

The provided code snippets in the Usage Examples section demonstrate basic database management operations.

Events

The server emits events for various operations:

• database-added: Triggered when a new database is discovered
• database-changed: Triggered when a database is modified
• database-removed: Triggered when a database is removed
• error: Triggered when an error occurs
• initialized: Triggered after the server is fully initialized

Development

# Run in development mode with automatic reloading
npm run dev

# Run tests
npm test

# Build the TypeScript code
npm run build

Continuous Integration

This project uses GitHub Actions for continuous integration:

• Runs on Node.js 20.x, 21.x, and 22.x
• Automatically runs tests on every push and pull request
• Checks TypeScript compilation
• Generates and uploads test coverage reports
• Fails if code quality standards are not met

📄 License

This project is licensed under the ISC license.

💡 Contribution

1. Fork the repository
2. Create a feature branch
3. Commit your changes
4. Push to the branch
5. Create a Pull Request