MCP Clickzetta Server

🚀 Clickzetta Installation Guide for Claude Desktop Server

This guide provides instructions on installing the Clickzetta server for the Claude desktop application. It details multiple installation methods, configuration steps, and offers information on features, example queries, security, and common issues.

🚀 Quick Start

Installation Methods Overview

1. Automated Installation via Smithery (Pending Testing)

Automatically install Clickzetta Server using Smithery:

npx -y @smithery/cli@latest install @yunqiqiliang/mcp-clickzetta-server --client claude --key ******

2. Manual Installation via UVX (Pending Testing)

Add the server to claude_desktop_config.json:

# Add the following content to your claude_desktop_config.json file
"mcpServers": {
  "clickzetta_pip": {
      "command": "uvx",
      "args": [
          "mcp_clickzetta_server",
          "--service",
          "the_service", # Replace with the actual service name
          "--instance",
          "the_instance", # Replace with the actual instance name
          "--vcluster",
          "the_vcluster", # Replace with the actual vcluster name
          "--workspace",
          "the_workspace", # Replace with the actual workspace
           "--schema",
          "the_schema", # Replace with the actual schema name
          "--user",
          "the_user", # Replace with the actual username
          "--password",
          "their_password" # Replace with the actual password
          # Optional parameters:
          # --allow_write (Not recommended)
          # --log_dir, "/absolute/path/to/logs"
          # --log_level, "DEBUG"/"INFO"/"WARNING"/"ERROR"/"CRITICAL"
          # --exclude_tools, "{tool name}", ["{other tool names}"]
      ]
  }
}

📦 Installation

Installation via UV Command-Line Tool

Execute the following command in the terminal:

uv --directory /Users/your_username/Documents/GitHub/mcp-clickzetta-server run mcp_clickzetta_server

Configuration Instructions

1. Open the Claude desktop application, go to Settings → MCP Servers.
2. Add a new server configuration:

   {
      "mcpServers": {
         "clickzetta-mcp-server" : {
             "command": "/Users/your_username/anaconda3/bin/uv",
             "args": [
                 "--directory",
                 "/Users/your_username/Documents/GitHub/mcp-clickzetta-server",
                 "run",
                 "mcp_clickzetta_server"
              ]
          }
       }
   }
   

3. Save the configuration.

Configuration Using Environment Variables

Add the following content to your .env file:

# Example .env configuration file
SERVICE_NAME=your_service_name
INSTANCE_NAME=your_instance_name
VCENTER_NAME=your_vcenter_name
WORKSPACE_NAME=your_workspace_name
SCHEMA_NAME=your_schema_name
DB_USER=your_database_user
DB_PASSWORD=your_database_password

✨ Features

• Read-Only Operations: Only SELECT statements are allowed.
• ResultSet Limitation: Automatically adds a LIMIT clause to prevent large data returns.
• Service Account Authentication: Secure connection through a service account.
• Input Validation: Prevents SQL injection attacks.

💻 Usage Examples

Querying Basic Configuration

clickzetta-mcp-server --schema your_schema --user your_user --password your_password

Example Output

{
  "status": "success",
  "result": {
    "data": [
      {
        "column1": "value1",
        "column2": "value2"
      }
    ],
    "rowCount": 10,
    "columns": ["column1", "column2"]
  }
}

⚠️ Important Note

• Configuration File Protection: Ensure the security of the .env file to avoid exposing database credentials.
• Network Access Control: Limit the network access scope of the server.

❓ Frequently Asked Questions

Can't connect to the database?

• Check if the database service is available.
• Confirm that the credential information is correct.

The returned result is empty?

• Check if the query syntax is correct.
• Ensure you have sufficient permissions to execute the query.