MCP Vertica

A Vertica MCP(model-context-protocol) Server

Example: MCP Server Setting

Create or edit the file your mcp client config file with the following content:

{
  "mcpServers": {
    "vertica": {
      "command": "uvx",
      "args": [
        "mcp-vertica",
        "--host=localhost",
        "--db-port=5433",
        "--database=VMart",
        "--user=dbadmin",
        "--password=",
        "--connection-limit=10"
      ]
    }
  }
}

[!Note]

• For boolean flags like --ssl or --ssl-reject-unauthorized, simply add the flag (e.g., "--ssl") to enable it, or omit it to disable.
• For an empty password, use an empty string as shown above.

Features

Database Connection Management

• Connection pooling with configurable limits
• SSL/TLS support
• Automatic connection cleanup
• Connection timeout handling

Query Operations

• Execute SQL queries
• Stream large query results in batches
• Copy data operations
• Transaction management

Schema Management

• Table structure inspection
• Index management
• View management
• Constraint information
• Column details

Security Features

• Operation-level permissions (INSERT, UPDATE, DELETE, DDL)
• Schema-specific permissions
• SSL/TLS support
• Password masking in logs

Tools

Database Operations

1. execute_query

   • Execute SQL queries
   • Support for all SQL operations

2. stream_query

   • Stream large query results in batches
   • Configurable batch size

3. copy_data

   • Bulk data loading using COPY command
   • Efficient for large datasets

Schema Management

1. get_table_structure

   • Get detailed table structure
   • Column information
   • Constraints

2. list_indexes

   • List all indexes for a table
   • Index type and uniqueness
   • Column information

3. list_views

   • List all views in a schema
   • View definitions

Configuration

Environment Variables

VERTICA_HOST=localhost
VERTICA_PORT=5433
VERTICA_DATABASE=VMart
VERTICA_USER=newdbadmin
VERTICA_PASSWORD=vertica
VERTICA_CONNECTION_LIMIT=10
VERTICA_SSL=false
VERTICA_SSL_REJECT_UNAUTHORIZED=true

Operation Permissions

ALLOW_INSERT_OPERATION=false
ALLOW_UPDATE_OPERATION=false
ALLOW_DELETE_OPERATION=false
ALLOW_DDL_OPERATION=false

Schema Permissions

SCHEMA_INSERT_PERMISSIONS=schema1:true,schema2:false
SCHEMA_UPDATE_PERMISSIONS=schema1:true,schema2:false
SCHEMA_DELETE_PERMISSIONS=schema1:true,schema2:false
SCHEMA_DDL_PERMISSIONS=schema1:true,schema2:false

Installation

uvx mcp-vertica

License

This project is licensed under the MIT License - see the LICENSE file for details.

Running in Docker Environment

When running Vertica with Docker Compose, you can run the MCP server as follows:

1. Run with Direct Parameters

uvx mcp-vertica 
  --host localhost 
  --db-port 5433 
  --database VMart 
  --user dbadmin 
  --password "" 
  --connection-limit 10

2. Run with Environment Variables

Create a .env file with the following content:

VERTICA_HOST=localhost
VERTICA_PORT=5433
VERTICA_DATABASE=test_db
VERTICA_USER=test_user
VERTICA_PASSWORD=test_password
VERTICA_CONNECTION_LIMIT=10
VERTICA_SSL=false
VERTICA_SSL_REJECT_UNAUTHORIZED=true

Then run with .env

uvx mcp-vertica 
  --env-file .env

For Testing, VerticaDB Docker Compose Example

version: "3.8"

services:
  vertica:
    # image: vertica/vertica-ce:11.1.0-0
    image: vertica/vertica-ce:latest
    platform: linux/amd64
    container_name: vertica-ce
    environment:
      VERTICA_MEMDEBUG: 2
    ports:
      - "5433:5433"
      - "5444:5444"
    volumes:
      - vertica_data:/home/dbadmin/VMart
    healthcheck:
      test:
        [
          "CMD",
          "/opt/vertica/bin/vsql",
          "-h",
          "localhost",
          "-d",
          "VMart",
          "-U",
          "dbadmin",
          "-c",
          "SELECT 1",
        ]
      interval: 10s
      timeout: 5s
      retries: 5
      start_period: 30s
    restart: unless-stopped

volumes:
  vertica_data:
    driver: local