Skip to main content
This guide covers installing HashPilot and configuring it with your preferred AI editor.

Install HashPilot

npm install -g hashpilot

Option 2: Use with npx (No Installation)

You can run HashPilot directly with npx - no global installation required:
npx hashpilot
When using npx in your MCP configuration, use npx -y hashpilot to auto-confirm the install prompt.

Environment Variables

HashPilot requires these environment variables in your MCP configuration:
VariableRequiredDescription
HEDERA_NETWORKYesNetwork to use: testnet, mainnet, or previewnet
HEDERA_OPERATOR_IDYesYour Hedera account ID (e.g., 0.0.12345)
HEDERA_OPERATOR_KEYYesYour private key in hex format
OPENAI_API_KEYFor RAGRequired for documentation search and code generation

Getting a Hedera Account

  1. Visit portal.hedera.com
  2. Create a free account
  3. Navigate to the Testnet tab
  4. Copy your Account ID (e.g., 0.0.12345)
  5. Copy your Private Key (DER encoded hex string)
Never share your private key. Keep it secure and only use testnet keys for development.

Editor Configuration

Choose your AI editor below for specific setup instructions.
  • Claude Desktop
  • Cursor
  • Windsurf
  • VS Code

Claude Desktop

Config file location:
  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%\Claude\claude_desktop_config.json
  • Linux: ~/.config/Claude/claude_desktop_config.json
Configuration:
{
  "mcpServers": {
    "hashpilot": {
      "command": "npx",
      "args": ["-y", "hashpilot"],
      "env": {
        "HEDERA_NETWORK": "testnet",
        "HEDERA_OPERATOR_ID": "0.0.YOUR_ACCOUNT_ID",
        "HEDERA_OPERATOR_KEY": "YOUR_PRIVATE_KEY_HEX",
        "OPENAI_API_KEY": "sk-YOUR_OPENAI_KEY"
      }
    }
  }
}
Steps:
  1. Create or edit the config file at the location above
  2. Add the configuration with your credentials
  3. Restart Claude Desktop
  4. Test by asking: “Use the health_check tool”

Using Global Installation

If you installed HashPilot globally, you can use hashpilot directly instead of npx:
{
  "mcpServers": {
    "hashpilot": {
      "command": "hashpilot",
      "env": {
        "HEDERA_NETWORK": "testnet",
        "HEDERA_OPERATOR_ID": "0.0.YOUR_ACCOUNT_ID",
        "HEDERA_OPERATOR_KEY": "YOUR_PRIVATE_KEY_HEX",
        "OPENAI_API_KEY": "sk-YOUR_OPENAI_KEY"
      }
    }
  }
}

Verify Installation

After configuring your editor, test that HashPilot is working:
  1. Ask your AI assistant: “Run the health_check tool”
  2. You should see a response with HashPilot version and status
{
  "success": true,
  "data": {
    "status": "healthy",
    "version": "0.1.0",
    "network": "testnet",
    "operatorId": "0.0.12345"
  }
}

Next Steps