Registry / database / omnibase-mcp

omnibase-mcp

JSON →
library0.1.30jsnpmunverified

Omnibase-MCP (Multi-Agent Communication Protocol) is a server designed to provide universal database access for AI agents. It acts as a central control plane, enabling agents to interact with various SQL databases such as PostgreSQL, MySQL, and SQLite. The package, currently in version 0.1.30, is under rapid and active development with frequent minor releases, often multiple times a month, indicating a project in its early, evolving stages. Key differentiators include a dynamic driver plugin architecture, comprehensive CLI tools for lifecycle management (e.g., upgrade, status monitoring), and support for user-defined custom tools. Its core purpose is to abstract database-specific complexities, allowing AI agents to perform complex data queries and management tasks through a unified interface.

npm install omnibase-mcp
INSTALL
IMPORT
SIG · OMNIBASE-MCP
O
omnibase-mcp
databasejavascriptv0.1.30
Install
Import
Disk
Pass rate
0/ 6
Env Coverage0 / 6
glibc
1822
musl
1822
Install & Compatibility
Where this runs
tested against v? · npm install
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
node 18226 runs
build_error
glibc
node 18226 runs
build_error
Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

startMcp
import { startMcp } from 'omnibase-mcp';
Used to programmatically start the MCP server. This is a common entry point for embedded or test environments, rather than direct CLI usage.
Server
import { Server } from 'omnibase-mcp';
The core Server class allows for advanced programmatic configuration and management of the MCP server instance.
McpConfig
import type { McpConfig } from 'omnibase-mcp';
Represents the configuration interface for the MCP server, useful for TypeScript users to ensure type safety when defining server settings.

This quickstart demonstrates how to programmatically start the Omnibase MCP server with a basic SQLite database configuration, showing typical server setup and graceful shutdown handling.

import { startMcp } from 'omnibase-mcp'; import path from 'path'; async function main() { // Example configuration for the MCP server. Real applications would fetch this securely. const config = { // Ensure your database drivers are available at runtime or via plugins. databases: [ { name: 'my_app_db', type: 'sqlite', connectionString: 'sqlite://' + path.join(process.cwd(), 'my_app.sqlite'), }, // Add more database configurations here (e.g., PostgreSQL, MySQL) ], // The port on which the MCP server will listen. port: process.env.MCP_SERVER_PORT ? parseInt(process.env.MCP_SERVER_PORT) : 8000, // Enable or disable specific features, e.g., custom tools. enableCustomTools: true, logLevel: 'info' }; try { console.log(`Starting Omnibase MCP server on port ${config.port}...`); // Start the MCP server programmatically const server = await startMcp(config); console.log('Omnibase MCP server started successfully.'); // Keep the process alive, or set up graceful shutdown handlers process.on('SIGINT', async () => { console.log('Stopping Omnibase MCP server...'); // Assuming server.close() exists for graceful shutdown // await server.close(); console.log('Omnibase MCP server stopped.'); process.exit(0); }); process.on('SIGTERM', async () => { console.log('Stopping Omnibase MCP server...'); // await server.close(); console.log('Omnibase MCP server stopped.'); process.exit(0); }); } catch (error) { console.error('Failed to start Omnibase MCP server:', error); process.exit(1); } } main();
omnibase --version
Debug
Known issues
breakingAs a 0.1.x package, `omnibase-mcp` is in an early development stage. APIs are highly unstable and breaking changes are frequent across minor and patch versions without explicit major version bumps. Always review changelogs between updates.
fix
Pin to exact patch versions (`~0.1.x` or `0.1.x`) or exact minor versions (`^0.1.x`) and thoroughly test updates. Monitor the GitHub repository for breaking changes and development progress.
affects: >=0.1.0
gotchaThe package relies on a dynamic driver plugin architecture for database connectivity. This implies that specific database drivers (e.g., PostgreSQL, MySQL) might need to be separately installed or configured at runtime for the server to function with those databases.
fix
Consult the Omnibase documentation for instructions on installing and configuring specific database drivers required by your setup. Ensure all necessary runtime dependencies are met before starting the server.
affects: >=0.1.0
gotchaFrequent releases (multiple per month) indicate rapid development, but also potential instability or unannounced changes in behavior. Pay close attention to CLI command arguments and configuration file formats which may evolve quickly.
fix
Always refer to the latest documentation or `--help` output for CLI commands. Back up configurations before updating and test in a staging environment.
affects: >=0.1.0
gotchaPast releases indicate issues with the npm publish payload (e.g., README not included, or being blocked by WAFs). While fixed in specific versions, this highlights potential for inconsistent package content or build issues in future pre-1.0 releases.
fix
Verify package contents after `npm install` if unexpected behavior occurs, especially around documentation or assets. Report any inconsistencies to the maintainers.
affects: >=0.1.0
Errors
Common errors & fixes
Error: Database connection failed: <Driver not found or connection string invalid>
The Omnibase MCP server could not establish a connection to the configured database, likely due to a missing driver, incorrect connection string, or inaccessible database server.
fix
Ensure the required database driver (e.g., `pg` for PostgreSQL, `mysql2` for MySQL) is installed as a dependency if not bundled. Verify the database server is running and accessible from the MCP server, and that the connection string in the configuration is correct.
Error: Unknown command: <command>
When running `omnibase-mcp` from the command line, an unrecognized argument or subcommand was provided. The CLI interface is subject to change.
fix
Run `omnibase-mcp --help` to see a list of available commands and their options for your installed version. Check the package's changelog for recent CLI changes.
Error: Configuration validation failed: <details about missing/invalid field>
The server failed to start because the provided configuration object (either from a file or programmatic) does not conform to the expected schema, possibly due to a missing required field or an invalid value type.
fix
Review the `McpConfig` type definition or the example configuration in the documentation. Ensure all required fields are present and correctly typed. This is particularly relevant given the rapid development pace and potential for config schema changes.
Upgrade
Version history
0.1.30latest on npm
Audit
Dependencies

No dependency data recorded yet.

Agent activity
14 hits · last 30 days
node
12
Amazon
1
OpenAI (training)
1
Resources