Hedera Dev Hedera MCP Server

🚀 Hedera MCP Server

A Model Context Protocol (MCP) server for interacting with the Hedera network. This server provides tools for creating Hedera wallets, checking account balances, building transactions, and sending signed transactions.

🚀 Quick Start

This MCP server enables seamless interaction with the Hedera network, offering a suite of tools for wallet management and transaction handling.

✨ Features

• Create new Hedera accounts.
• Check the balance of Hedera accounts.
• Build unsigned transfer transactions.
• Submit signed transactions to the Hedera network.

📦 Installation

Prerequisites

• Node.js (v18 or higher)
• npm or yarn
• A Hedera account (for testnet or mainnet)

Steps

1. Clone the repository:

git clone https://github.com/hedera-dev/hedera-mcp-server.git
cd hedera-mcp-server

2. Install dependencies:

npm install

3. Create a .env file in the root directory with your Hedera credentials:

HEDERA_OPERATOR_ID=your-operator-account-id
HEDERA_OPERATOR_KEY=your-operator-private-key
HEDERA_NETWORK=testnet  # or mainnet
PORT=3000  # Optional, default is 3000

🔧 Compilation

Compile TypeScript code:

npm run build

For development with auto-recompilation:

npm run dev

💻 Usage Examples

Run the server

npm start

The server will run at http://localhost:3000 (or the port you specified).

Test with the test client

This repository includes a test client script that demonstrates how to connect to the MCP server and use its tools. The client provides an end-to-end demonstration of the full process from account creation to transaction submission.

Run the test client:

node test-client.js

The test client will:

1. Connect to the MCP server.
2. List all available tools.
3. Create a new Hedera account (using the create-wallet tool).
4. Check the balance of the new account (using the check-balance tool).
5. Build a transaction to transfer the entire balance to the operator account (using the build-transaction tool).
6. Sign the transaction on the client side using the Hedera SDK.
7. Submit the signed transaction to the Hedera network (using the send-transaction tool).
8. Display the transaction result.

This showcases the complete lifecycle of interacting with the Hedera network through the MCP server, from account creation to transaction submission.

📚 Documentation

Available MCP Tools

The server provides the following tools:

1. create-wallet: Create a new Hedera account (with a minimum initial balance).

   • No input parameters.
   • Returns the account ID, public key, and private key.

2. check-balance: Check the balance of a Hedera account.

   • Input: accountId (string).
   • Returns the account balance in tinybars.

3. build-transaction: Build an unsigned transfer transaction.

   • Input:
     • senderAccountId (string).
     • recipientAccountId (string).
     • amount (number, in tinybars).
   • Returns the base64-encoded transaction content.

4. send-transaction: Submit a signed transaction to the Hedera network.

   • Input: signedTransaction (string, base64-encoded).
   • Returns the transaction status and result.

🚀 Deployment

Run the deployment script:

chmod +x deploy.sh
./deploy.sh

This script will start your MCP server.