@@ -57,55 +57,105 @@ Each tool validates inputs with `zod` and executes using `viem` on the configure
5757### Prerequisites
5858
5959- Node.js 18+
60- - An RPC endpoint for Hyperliquid EVM
61- - A funded private key for actions that require signing (e.g., send funds, deploy)
60+ - A private key for actions that require signing (e.g., send funds, deploy, stake)
6261
6362### Installation
6463
65- ``` bash
66- npm install
67- ```
64+ ### Option 1: Integration with Claude Desktop
6865
69- ### Configuration
66+ To add this MCP server to Claude Desktop:
67+
68+ Create or edit the Claude Desktop configuration file at:
69+
70+ - ** macOS** : ` ~/Library/Application Support/Claude/claude_desktop_config.json `
71+ - ** Windows** : ` %APPDATA%\Claude\claude_desktop_config.json `
72+ - ** Linux** : ` ~/.config/Claude/claude_desktop_config.json `
73+
74+ You can easily access this file via the Claude Desktop app by navigating to ** Claude > Settings > Developer > Edit Config** .
7075
71- Copy the environment file :
76+ Add the following configuration :
7277
78+ ``` json
79+ {
80+ "mcpServers" : {
81+ "nexus" : {
82+ "command" : " npx" ,
83+ "args" : [" -y" , " blocsociitr-nexus@latest" ],
84+ "env" : {
85+ "CHAIN_ID" : " 998" ,
86+ "CHAIN_RPC_URL" : " https://hyperliquid-testnet.drpc.org" ,
87+ "BLOCK_EXPLORER_URL" : " https://hyperevm-explorer.vercel.app/" ,
88+ "IS_TESTNET" : " true" ,
89+ "PRIVATE_KEY" : " your_private_key_here"
90+ }
91+ }
92+ }
93+ }
7394```
74- cp .env.example .env
95+
96+ ⚠️ Important:
97+ 1 . Replace YOUR_PRIVATE_KEY_HERE with your actual private key
98+ 2 . Your private key MUST start with 0x
99+ 3 . Restart Claude Desktop after saving the config
100+
101+ ### Option 2: Run Locally (For Contributing or Development)
102+
103+ Clone this repository:
104+
105+ ``` bash
106+ git clone https://github.com/blocsociitr/nexus.git
107+ cd nexus
75108```
76109
77- The server uses ` src/config.ts ` to define the chain and to create a ` viem ` wallet client from these values.
110+ Install dependencies:
78111
79- ### Build and run
112+ ``` bash
113+ npm install
114+ ```
115+
116+ Build the project:
80117
81118``` bash
82119npm run build
83- npm start
84120```
85121
86- You should see: "Hyperliquid MCP Server running on stdio".
87-
88- ## Using the server from an MCP client
122+ ### Configuration
89123
90- Any MCP-compatible client can :
124+ Create a ` .env ` file with your credentials :
91125
92- 1 . List tools
93- 2 . Call tools with JSON arguments that match the advertised schemas
126+ ``` bash
127+ # Hyperliquid EVM Configuration
128+ # Chain ID for Hyperliquid EVM
129+ # Use 998 for Hyperliquid Testnet, 1 for Mainnet
130+ CHAIN_ID=998
131+
132+ # RPC endpoint for Hyperliquid EVM
133+ # Testnet: https://hyperliquid-testnet.drpc.org
134+ # Mainnet: https://hyperliquid.drpc.org
135+ CHAIN_RPC_URL=https://hyperliquid-testnet.drpc.org
136+
137+ # Block explorer URL
138+ # Testnet: https://hyperevm-explorer.vercel.app/
139+ # Mainnet: https://explorer.hyperliquid.io/
140+ BLOCK_EXPLORER_URL=https://hyperevm-explorer.vercel.app/
141+
142+ # Set to true for testnet, false for mainnet
143+ IS_TESTNET=true
144+
145+ # Your private key
146+ PRIVATE_KEY=your_private_key_here
147+ ```
94148
95- Example tool calls (names only; argument shapes are defined by the server):
149+ ### Build and Run
96150
97- - get_latest_block
98- - get_balance { userAddress }
99- - get_token_balance { contractAddress, userAddress }
100- - send_funds { receiverAddress, amountToSend }
101- - deploy_contracts { abi, bytecode, constructorArguments }
102- - get_transaction_receipt { txHash }
103- - stake { amountToStake, validatorAddress, isTestnet }
104- - unstake { amountToUnstake, validatorAddress, isTestnet }
151+ ``` bash
152+ npm run build
153+ npm start
154+ ```
105155
106- Inspect ` src/main.ts ` and ` src/tools/** ` for exact schemas and behaviors .
156+ You should see: "Hyperliquid MCP Server running on stdio" .
107157
108- ## Development
158+ ### Development
109159
110160- Build: ` npm run build `
111161- Dev: ` npm run dev `
122172 tools/ # tool definitions and implementations
123173 tools.ts # Tool metadata + schemas for MCP
124174 hyper-evm/ # EVM-specific tool implementations
175+ hyper-core/ # hyperCore specific tool implementations
125176```
126177
127178## Team
0 commit comments