Hts MCP Server

🚀 Hedera MCP Server

A Model Context Protocol (MCP) server for interacting with the Hedera network. This server offers functions such as creating Hedera wallets, checking account balances, constructing transactions, and sending signed transactions.

🚀 Quick Start

The Hedera MCP Server is designed to facilitate interaction with the Hedera network. It enables users to perform various operations like wallet creation, balance checking, and transaction handling.

✨ Features

Security Warning

⚠️ Important Note

This is a demonstration implementation and is not suitable for production use. The current implementation has several security vulnerabilities:

• Private keys are returned in plain text in the response body.
• Sensitive data is not encrypted.
• There is no transaction verification mechanism.

This implementation aims to demonstrate the MCP concept and should be properly secured before being deployed in production.

Main Objectives

The primary purpose of the MCP server is to show how to fully handle transaction construction and submission through the MCP server, with the client only needing to verify the transactions. Specifically:

1. Transaction construction is fully completed on the MCP server.
2. The client signs the generated transactions.
3. The MCP server is responsible for submitting the transactions to the Hedera network.
4. This architecture allows for centralized transaction logic and reduces client complexity.

Available MCP Tools

The server provides the following tools:

1. create-wallet: Create a new Hedera account and set the minimum initial balance.
2. check-balance: Check the current balance of a specified account.
3. build-transaction: Construct a transaction to transfer funds from a specified account to a target address.
4. send-transaction: Submit a signed transaction to the Hedera network.

Each tool has specific input and output formats. Please refer to the relevant documentation for detailed information.

📦 Installation

Prerequisites

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

Steps

1. Clone this 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 project root directory containing 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
   

💻 Usage Examples

Compile the Application

Compile the TypeScript code:

npm run build

For automatic recompilation in a development environment:

npm run dev

Start the Server

Start the server:

npm start

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

Test with the Test Client

This repository contains a test client script that demonstrates how to connect to the MCP server and use its tools. The client provides a complete end-to-end process, showing all available functions.

Run the test client:

node test-client.js

The test client will perform the following steps:

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

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

Deployment

To deploy the server, run the following commands:

npm install

Then start the server:

npm start

Make sure you have configured the .env file and installed all dependencies.