bnbchain-mcp/README.npm.md

---

---

## 📦 BNBChain MCP – Binance Smart Chain Tool Server (MCP + CLI Ready)

> A plug-and-play MCP tool server to **send BNB**, **transfer BEP-20 tokens**, **deploy tokens**, and **interact with smart contracts** on the **Binance Smart Chain (BSC)** — built for **Claude Desktop**, **AI agents**, and **developers.**

---

### ⚙️ Core Capabilities

- 🔐 Secure token & native transfers via CLI or MCP
- 🧱 Interact with smart contracts (ABI/function-based)
- 🔄 PancakeSwap integration for swaps & liquidity
- ⚙️ Create meme tokens & deploy BEP-20 smart contracts
- 🧠 Native Claude Desktop integration via MCP
- 🔧 CLI-ready, MCP-compliant, developer-friendly

---

## 🛠 Installation & Setup

### 1. Clone & Install

```bash
npm install -g bnbchain-mcp
```

### 2. Run the CLI Setup Wizard

```bash
bnbchain-mcp --init
```

You’ll be prompted to enter:

- ✅ **Moralis API Key** *(optional)*  
- ✅ **BSC Wallet Private Key** *(required)*  
- ✅ **Custom RPC URL** *(optional, defaults to:* `https://bsc-dataseed.binance.org` *)

---

## 🧠 Claude Desktop Integration

After CLI setup, the tool can **auto-configure itself into Claude Desktop**.

📍 File modified:

```
~/Library/Application Support/Claude/claude_desktop_config.json
```

Claude will detect and run this MCP server with your selected tools.

---

## 🔨 Supported MCP Tools

| Tool Name             | Description                              |
|----------------------|------------------------------------------|
| `transferNativeToken` | Send BNB to a wallet                     |
| `transferBEP20Token`  | Transfer BEP-20 token via symbol/address |
| `pancakeSwap`         | Swap tokens via PancakeSwap              |
| `createFourMeme`      | Create meme token on Four.Meme           |
| `createBEP20Token`    | Deploy a BEP-20 contract                 |
| `getBalance`          | Get token + native balance               |
| `callContractFunction`| Custom contract calls via ABI            |
| `getWalletInfo`       | Get wallet info for an address           |
| `securityCheck`       | Check token security of BSC tokens       |
| `pancakeAddLiquidity` | Add liquidity to PancakeSwap             |
| `pancakeMyPosition`   | View your PancakeSwap positions          |
| `pancakeRemovePosition`| Remove liquidity from PancakeSwap        |
| `sellMemeToken`        | Sell meme token on Four.Meme             |
| ...and more coming soon 🔧 |

---

## 🧪 Development Workflow

### Compile TypeScript:
```bash
npm run build
```

### Start MCP Server:
```bash
npm start
# or
node build/index.js
```

### Re-configure:
```bash
bnbchain-mcp --init
```

---

## 🔑 Get Moralis API Key (For Wallet Balance)

📎 [Moralis API Docs](https://docs.moralis.com/2.0/web3-data-api/evm/get-your-api-key)

1. Visit: [https://moralis.io](https://moralis.io)
2. Sign up → Dashboard → Web3 Data → API Keys
3. Copy key and paste during CLI setup

---

## 📘 Model Context Protocol (MCP)

This project is built on **Model Context Protocol** – a standard to help agents and models interact with structured tool APIs.

**MCP Benefits**:
- ✅ Structured input/output
- ✅ Claude + OpenAI compatible
- ✅ Secure + serverless-ready

---

## ✅ Roadmap

- [x] CLI Configuration Wizard
- [x] Claude Desktop Integration
- [x] Token Deploy + Transfer
- [ ] Token charting tools (DEXTools, Gecko)
- [ ] Telegram auto-trading agent
- [ ] AI assistant with BSC on-chain brain

---

## 🤝 Contributing

Feel free to fork, PR, or raise issues.
We're building **tool-first, AI-ready infrastructure** for the next wave of Web3 agents. Join us!

---

## 🛡️ License

MIT — Use freely, contribute openly.

---