Db MCP Server

🚀 Database Management Console Server

The Database Management Console Server offers a comprehensive solution for managing multiple databases, integrating with OpenAI agents, and providing a user - friendly console for database operations.

🚀 Quick Start

Run the Server

# Start in console mode
./server -mode=console

# Start in SSE mode (for OpenAI agent integration)
./server -mode=sse

Basic Configuration File Example

{
    "connections": [
        {
            "id": "mysql1",
            "type": "mysql",
            "host": "mysql1",
            "port": 3306,
            "name": "db1",
            "user": "user1",
            "password": "pass1"
        }
    ]
}

✨ Features

• Multi - database Support: Supports multiple mainstream databases such as MySQL and PostgreSQL.
• SSE Mode Integration: Perfectly compatible with OpenAI's Agents SDK, enabling interaction with AI agents via the SSE protocol.
• Query Timeout Configuration: Allows setting query timeout for each database connection individually, with a default of 30 seconds.
• High - availability Design: Built - in connection pool and load - balancing features ensure efficient and stable database operations.

💻 Usage Examples

Console Operation Commands

Basic Commands

• help: Display all available commands.
• query: Execute SQL queries, supporting timeout parameters.
• describe: View table structure information.
• execute: Perform DML operations (e.g., INSERT, UPDATE, DELETE).
• schema: Get database schema information.
• connections: Manage database connection status.

Examples

# Execute a query
query mysql1 "SELECT * FROM users LIMIT 10"

# Query with timeout setting
query mysql1 --timeout=60 "SELECT * FROM large_table"

# View table structure
describe mysql1 users

🔧 Technical Details

Error Handling

Common Errors

• Connection Timeout: Check if the target database service is running properly.
• Insufficient Permissions: Confirm that the user has the appropriate database permissions.
• Syntax Error: Carefully check the SQL statement for spelling or syntax issues.

Logging

The server outputs logs to the logs/ directory by default, supporting four log levels: DEBUG, INFO, WARNING, and ERROR.

OpenAI Agent SDK Integration

Compatibility

• Supports interaction with models like OpenAI's GPT - 4o via the SSE protocol.
• Provides a complete database toolchain, including query, describe, and execute functions.

Basic Integration Example

from openai import OpenAI
from agents.agent import Agent, ModelSettings
from agents.tools.mcp_server import MCPServerSse, MCPServerSseParams

# Initialize the MCP server connection
db_server = MCPServerSse(
    params=MCPServerSseParams(
        url="http://localhost:9095/sse"
    ),
)

# Create an agent with database operation capabilities
agent = Agent(
    name="Database Assistant",
    model="gpt-4o",
    model_settings=ModelSettings(temperature=0.1),
    instructions="""
    You are a professional database assistant, capable of executing SQL queries, managing transactions, and analyzing table structures.
    """,
    tools=[db_server]
)

Database Connection Pool Configuration

{
    "connections": [
        {
            "id": "mysql1",
            "type": "mysql",
            "host": "mysql1",
            "port": 3306,
            "name": "db1",
            "user": "user1",
            "password": "pass1",
            "pool_size": 5,
            "max_idle_time": 60
        }
    ]
}

Table Output Format

📚 Documentation

All documentation and design ideas can be found in the project repository.

⚠️ Important Note

Before using this tool, make sure you have read and understood the relevant security precautions, especially when using it in a production environment.