HANA CLI

Appearance

Model Context Protocol (MCP) Integration ​

Integrate HANA CLI with AI coding assistants via the Model Context Protocol for intelligent database operations.

What is MCP? ​

The Model Context Protocol enables AI assistants to interact with external tools and databases. The HANA CLI MCP Server exposes all CLI commands as standardized tools that AI agents can discover and use intelligently.

Key Capabilities:

  • 150+ Tools - All CLI commands accessible via MCP interface
  • Discovery - AI-guided command recommendations and smart search
  • Workflows - Pre-built multi-step task templates
  • Examples - Real-world usage scenarios and parameter presets
  • Documentation - Integrated access to 279 documentation pages
  • Resources - Browsable metadata, schemas, and command catalog
  • Prompts - Guided conversation workflows for common tasks

Quick Start ​

If you already have hana-cli installed, use the built-in install command:

bash
# Auto-detect installed clients and configure them
hana-cli mcp

# Preview what would be written without making changes
hana-cli mcp --dry-run

# Target a specific client
hana-cli mcp --client claude-desktop
hana-cli mcp --client claude-code --global
hana-cli mcp --client cursor

# Check configuration status across all clients
hana-cli mcp-status

See mcpServerInstall for full documentation.

Option 2: npx (No Installation) ​

Run the MCP server directly via npx without installing anything:

bash
npx -y -p hana-cli hana-cli-mcp

Use this in your IDE's MCP configuration:

json
{
  "mcpServers": {
    "hana-cli": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "-p", "hana-cli", "hana-cli-mcp"]
    }
  }
}

Option 3: VS Code Extension ​

Install the SAP HANA CLI MCP Server extension from the VS Code Marketplace. Search for @mcp in the Extensions view, or install from the command line:

bash
code --install-extension SAPOSS.hana-cli-mcp

This registers the MCP server with VS Code automatically — no manual configuration needed. Works with GitHub Copilot agent mode and other AI assistants.

Source: SAP-samples/hana-cli-vscode-mcp

Option 4: Claude Code Plugin ​

Install the hana-cli plugin directly in Claude Code:

text
/plugin install https://github.com/SAP-samples/hana-cli-claude-plugin

Source: SAP-samples/hana-cli-claude-plugin

Option 5: MCP Registry ​

The MCP server is published to the MCP Registry as io.github.SAP-samples/hana-cli. AI clients and aggregators that support the MCP Registry can discover and install it automatically.

Manual Configuration ​

You can also point directly to a local build:

json
{
  "mcpServers": {
    "hana-cli": {
      "type": "stdio",
      "command": "node",
      "args": [
        "/absolute/path/to/mcp-server/build/index.js"
      ]
    }
  }
}

TIP

Replace the path with your actual project location. Connection credentials are read from default-env.json in the project root. Use hana-cli connect or hana-cli serviceKey to configure database connections.

Core Features ​

1. Command Tools ​

All CLI commands are exposed with the hana_ prefix:

text
hana_status              Check database connection
hana_tables              List tables in a schema
hana_import              Import data from CSV/Excel
hana_dataProfile         Analyze data quality
hana_duplicateDetection  Find duplicate rows
hana_compareSchema       Compare database schemas
hana_inspectTable        View table structure and metadata

Command aliases still work when called (e.g., hana_s for status, hana_imp for import), but they are not registered as separate tools to keep the tool list concise.

2. Discovery Tools ​

Help AI agents find the right tools:

hana_recommend - Get command suggestions based on natural language intent:

text
Input: "find duplicate rows in my customer table"
Output: Top 5 matching commands with confidence scores and parameter templates

hana_search - Search across commands, workflows, examples, presets, and documentation:

text
Input: "csv import"
Output: Related commands, workflows, examples, and documentation

hana_quickstart - Essential commands guide for new users covering the 6 most common operations.

3. Examples and Presets ​

hana_examples - Get real-world usage scenarios:

text
Input: { command: "import" }
Output: Multiple scenarios with complete parameter sets and best practices

hana_parameter_presets - Pre-configured parameter combinations for common use cases:

text
Input: { command: "dataProfile", useCase: "data_quality" }
Output: Recommended parameters for comprehensive analysis

4. Workflows ​

hana_workflows - List available multi-step workflow templates:

text
Available workflows:
- data-quality-check
- schema-comparison
- performance-optimization
- safe-import
- data-migration
... and 15+ more

hana_workflow_by_id - Get detailed steps for a specific workflow.

5. Documentation Access ​

hana_get_doc - Retrieve full content of a documentation page found via search:

text
Input: "import csv with errors"
Output: Top 10 relevant documentation pages with excerpts

hana_get_doc - Retrieve complete documentation page content.

Use Cases ​

Database Exploration ​

Ask your AI assistant:

"Show me the structure of tables in the HR schema"

The AI will:

  1. Use hana_recommend to find relevant commands
  2. Execute hana_tables to list tables
  3. Use hana_inspectTable to examine structure
  4. Format results in a readable summary

Data Quality Analysis ​

"Analyze data quality in my SALES.ORDERS table"

The AI will:

  1. Execute hana_dataProfile for statistical analysis
  2. Run hana_duplicateDetection to find duplicates
  3. Use hana_dataValidator to check constraints
  4. Provide a comprehensive quality report

Import Automation ​

"Import all CSV files from the data/ folder into my schema"

The AI will:

  1. Check available tables with hana_tables
  2. Use hana_examples to get import templates
  3. Generate appropriate import commands for each file
  4. Provide error handling recommendations

Schema Migration ​

"Compare my DEV and PROD schemas and show differences"

The AI will:

  1. Use hana_recommend to find schema comparison tools
  2. Execute hana_compareSchema with both connections
  3. Use result interpretation to highlight key differences
  4. Suggest next steps for migration

Advanced Features ​

Workflow Templates ​

Browse and use pre-built multi-step workflows:

text
hana_workflows          - List available workflow templates
hana_workflow_by_id     - Get detailed steps for a specific workflow
hana_search_workflows   - Search workflows by tag or purpose

The AI agent orchestrates the individual steps — workflow templates provide the sequence and recommended parameters, while the LLM handles execution and decision-making between steps.

Result Interpretation ​

hana_interpret_result - AI-friendly analysis and insights from command output, automatically providing context-aware explanations.

Conversation Templates ​

hana_conversation_templates / hana_get_template - Pre-built dialogue flows for guided troubleshooting and task completion.

Connection Management ​

Default Connection ​

The MCP server reads connection details from default-env.json in the project root. Configure using:

bash
# SAP BTP HANA Cloud
hana-cli serviceKey -i instance-name -k key-name

# Interactive setup
hana-cli connect

Project-Specific Connections ​

Tools accept an optional __projectContext parameter:

json
{
  "projectPath": "/path/to/project",
  "connectionFile": "default-env.json"
}

This allows AI agents to work with multiple database connections across different projects.

Complete Documentation ​

For comprehensive guides, implementation details, and troubleshooting:

See Also ​