Skip to main content

A MCP Server for Hologres

Project description

Hologres MCP Server

Hologres MCP Server serves as a universal interface between AI Agents and Hologres databases. It enables seamless communication between AI Agents and Hologres, helping AI Agents retrieve Hologres database metadata and execute SQL operations.

Configuration

Mode 1: Using Local File

Download

Download from Github

git clone https://github.com/aliyun/alibabacloud-hologres-mcp-server.git

MCP Integration

Add the following configuration to the MCP client configuration file:

"mcpServers": {
  "hologres-mcp-server": {
    "command": "uv",
    "args": [
      "--directory",
      "/path/to/alibabacloud-hologres-mcp-server",
      "run",
      "hologres-mcp-server"
    ],
    "env": {
      "HOLOGRES_HOST": "host",
      "HOLOGRES_PORT": "port",
      "HOLOGRES_USER": "access_id",
      "HOLOGRES_PASSWORD": "access_key",
      "HOLOGRES_DATABASE": "database"
    }
  }
}

Mode 2: Using PIP Mode

Installation

Install MCP Server using the following package:

pip install hologres-mcp-server

MCP Integration

Add the following configuration to the MCP client configuration file:

"mcpServers": {
    "hologres-mcp-server": {
      "command": "uv",
      "args": [
        "run",
        "--with",
        "hologres-mcp-server",
        "hologres-mcp-server"
      ],
      "env": {
        "HOLOGRES_HOST": "host",
        "HOLOGRES_PORT": "port",
        "HOLOGRES_USER": "access_id",
        "HOLOGRES_PASSWORD": "access_key",
        "HOLOGRES_DATABASE": "database"
      }
    }
  }

Components

Tools

  • execute_hg_select_sql: Execute a SELECT SQL query in Hologres database
  • execute_hg_select_sql_with_serverless: Execute a SELECT SQL query in Hologres database with serverless computing
  • execute_hg_dml_sql: Execute a DML (INSERT, UPDATE, DELETE) SQL query in Hologres database
  • execute_hg_ddl_sql: Execute a DDL (CREATE, ALTER, DROP, COMMENT ON) SQL query in Hologres database
  • gather_hg_table_statistics: Collect table statistics in Hologres database
  • get_hg_query_plan: Get query plan in Hologres database
  • get_hg_execution_plan: Get execution plan in Hologres database
  • call_hg_procedure: Invoke a procedure in Hologres database
  • create_hg_maxcompute_foreign_table: Create MaxCompute foreign tables in Hologres database.

Since some Agents do not support resources and resource templates, the following tools are provided to obtain the metadata of schemas, tables, views, and external tables.

  • list_hg_schemas: Lists all schemas in the current Hologres database, excluding system schemas.
  • list_hg_tables_in_a_schema: Lists all tables in a specific schema, including their types (table, view, external table, partitioned table).
  • show_hg_table_ddl: Show the DDL script of a table, view, or external table in the Hologres database.

Resources

Built-in Resources

  • hologres:///schemas: Get all schemas in Hologres database

Resource Templates

  • hologres:///{schema}/tables: List all tables in a schema in Hologres database

  • hologres:///{schema}/{table}/partitions: List all partitions of a partitioned table in Hologres database

  • hologres:///{schema}/{table}/ddl: Get table DDL in Hologres database

  • hologres:///{schema}/{table}/statistic: Show collected table statistics in Hologres database

  • system:///{+system_path}: System paths include:

    • hg_instance_version - Shows the hologres instance version.
    • guc_value/<guc_name> - Shows the guc (Grand Unified Configuration) value.
    • missing_stats_tables - Shows the tables that are missing statistics.
    • stat_activity - Shows the information of current running queries.
    • query_log/latest/<row_limits> - Get recent query log history with specified number of rows.
    • query_log/user/<user_name>/<row_limits> - Get query log history for a specific user with row limits.
    • query_log/application/<application_name>/<row_limits> - Get query log history for a specific application with row limits.
    • query_log/failed/<interval>/<row_limits> - Get failed query log history with interval and specified number of rows.

Prompts

None at this time

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hologres_mcp_server-0.1.8.tar.gz (37.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hologres_mcp_server-0.1.8-py3-none-any.whl (15.7 kB view details)

Uploaded Python 3

File details

Details for the file hologres_mcp_server-0.1.8.tar.gz.

File metadata

  • Download URL: hologres_mcp_server-0.1.8.tar.gz
  • Upload date:
  • Size: 37.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.14

File hashes

Hashes for hologres_mcp_server-0.1.8.tar.gz
Algorithm Hash digest
SHA256 30ed7a463974776aa77638ee9da2c828ab6fc88998c8d195abb46262da6ae2ad
MD5 f547109c23298cbb80136f510add3a73
BLAKE2b-256 7d5cb0316da63d170c9d3569f7bda7daf53dbf56598b5a9e012c6cc41e533f34

See more details on using hashes here.

File details

Details for the file hologres_mcp_server-0.1.8-py3-none-any.whl.

File metadata

File hashes

Hashes for hologres_mcp_server-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 3b0a25061b0bbe644cd0b4573d1ff83457d6a88c6a1f04a7aa7a4803c9f14ed5
MD5 29d9d784f13c7906f68dd6567307e59a
BLAKE2b-256 3df09a0f5cea6d60a17dc525567a98d99413671cb8aa2f210d2cb58a93a77e43

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page