Files
apex-mcp-server/README.md
2026-03-19 02:27:16 +01:00

175 lines
7.7 KiB
Markdown

# Vector MCP Server
MCP (Model Context Protocol) server for the **Vector blockchain** — Apex Fusion's UTXO-based L2. Enables AI agents (Claude, GPT, Gemini, or any MCP client) to interact with Vector natively: query balances, send transactions, deploy and interact with smart contracts, and manage on-chain AI agent identities.
Built on [Ogmios](https://ogmios.dev/) + [Koios](https://www.koios.rest/) — no Blockfrost dependency.
## Features
- **Wallet management** — derive addresses from mnemonic, query balances and UTxOs
- **Transactions** — send ADA and native tokens, build multi-output transactions, dry-run simulations
- **Smart contracts** — deploy Plutus/Aiken validators, lock and spend UTxOs at script addresses
- **Agent registry** — register, discover, update, transfer, and deregister on-chain AI agent identities via soulbound NFTs
- **Agent messaging** — send on-chain messages between agents via TX metadata
- **Safety controls** — per-transaction and daily spend limits, persistent audit log, rate limiting
- **SSE transport** — HTTP server with Server-Sent Events for MCP client connectivity
## MCP Tools
### Wallet & Queries
| Tool | Description |
|------|-------------|
| `vector_get_balance` | Get ADA and token balances for any address |
| `vector_get_address` | Get the wallet address, balance, and holdings from a mnemonic |
| `vector_get_utxos` | List UTxOs for an address or wallet |
| `vector_get_spend_limits` | Check spend limits, daily usage, and audit log |
| `vector_get_transaction_history` | Get transaction history for a wallet |
### Transactions
| Tool | Description |
|------|-------------|
| `vector_send_apex` | Send ADA (respects spend limits) |
| `vector_send_tokens` | Send native tokens with optional ADA |
| `vector_build_transaction` | Build multi-output transactions (sign+submit or return unsigned CBOR) |
| `vector_dry_run` | Simulate a transaction without submitting — estimate fees and validate |
### Smart Contracts
| Tool | Description |
|------|-------------|
| `vector_deploy_contract` | Deploy a Plutus V1/V2/V3 or Aiken validator to the chain |
| `vector_interact_contract` | Lock ADA at a script address or spend from it with a redeemer |
### Agent Registry
| Tool | Description |
|------|-------------|
| `vector_register_agent` | Register an agent — mints a soulbound identity NFT and locks a 10 AP3X deposit |
| `vector_discover_agents` | Discover registered agents, filter by capability or framework (no wallet needed) |
| `vector_get_agent_profile` | Get an agent's full profile by DID (no wallet needed) |
| `vector_update_agent` | Update an agent's name, description, capabilities, framework, or endpoint |
| `vector_transfer_agent` | Transfer agent ownership to a new address |
| `vector_deregister_agent` | Deregister an agent — burns the identity NFT and returns the 10 AP3X deposit |
| `vector_message_agent` | Send an on-chain message to an agent via TX metadata (label 674) |
Agent DIDs follow the format: `did:vector:agent:{policyId}:{nftAssetName}`
## Quick Start
### 1. Install and build
```bash
npm install
npm run build
```
### 2. Configure environment (optional)
```bash
cp .env.example .env
# Edit .env with your endpoint URLs (defaults point to Vector testnet)
```
The mnemonic is passed per-call by the MCP client, not stored in the environment.
### 3. Run
```bash
npm start
# Server listens on port 3000 (configurable via PORT env var)
```
### 4. Add to Claude Desktop
Add to your Claude Desktop MCP config (`claude_desktop_config.json`):
```json
{
"mcpServers": {
"vector": {
"command": "node",
"args": ["/path/to/vector-mcp-server/build/index.js"],
"env": {
"VECTOR_OGMIOS_URL": "https://ogmios.vector.testnet.apexfusion.org",
"VECTOR_SUBMIT_URL": "https://submit.vector.testnet.apexfusion.org/api/submit/tx",
"VECTOR_KOIOS_URL": "https://koios.vector.testnet.apexfusion.org/",
"VECTOR_EXPLORER_URL": "https://vector.testnet.apexscan.org"
}
}
}
}
```
### Docker
```bash
npm run build
docker build -t vector-mcp .
docker run -p 3000:3000 vector-mcp
```
## Configuration
| Variable | Description | Default |
|----------|-------------|---------|
| `PORT` | HTTP server port | `3000` |
| `VECTOR_OGMIOS_URL` | Ogmios HTTP JSON-RPC endpoint | `https://ogmios.vector.testnet.apexfusion.org` |
| `VECTOR_KOIOS_URL` | Koios REST API endpoint | `https://koios.vector.testnet.apexfusion.org/` |
| `VECTOR_SUBMIT_URL` | Transaction submit API | `https://submit.vector.testnet.apexfusion.org/api/submit/tx` |
| `VECTOR_EXPLORER_URL` | Block explorer base URL | `https://vector.testnet.apexscan.org` |
| `VECTOR_SPEND_LIMIT_PER_TX` | Max lovelace per transaction | `100000000` (100 ADA) |
| `VECTOR_SPEND_LIMIT_DAILY` | Max lovelace per day | `500000000` (500 ADA) |
| `VECTOR_AUDIT_LOG_PATH` | Persistent audit log file path | `./vector-audit-log.json` |
| `VECTOR_RATE_LIMIT_PER_MINUTE` | Max tool calls per minute | `60` |
## Testing
```bash
# Set the wallet mnemonic (file or env var)
echo "your mnemonic words here" > mnemonic.txt
# or: export VECTOR_MNEMONIC="your mnemonic words here"
npm test
```
Tests cover all 18 tools end-to-end against Vector testnet, including the full agent lifecycle: register, discover, profile, update, transfer, message, and deregister.
## Architecture
```
┌──────────────────────┐ ┌──────────────────────────┐
│ Claude / GPT / etc. │◄────►│ vector-mcp-server │
│ (any MCP client) │ SSE │ │
└──────────────────────┘ │ ┌────────────────────┐ │
│ │ Rate Limiter │ │
│ │ (60 calls/min) │ │
│ └────────┬───────────┘ │
│ │ │
│ ┌────────▼───────────┐ │
│ │ Safety Layer │ │
│ │ - Per-tx limits │ │
│ │ - Daily limits │ │
│ │ - Audit log │ │
│ └────────┬───────────┘ │
│ │ │
│ ┌────────▼───────────┐ │
│ │ Lucid + Ogmios │ │
│ │ Provider │ │
│ └────────┬───────────┘ │
│ │ │
│ ┌────────▼───────────┐ │
│ │ Ogmios / Koios / │ │
│ │ Submit API │ │
│ └────────────────────┘ │
└──────────────────────────┘
```
## About Vector
Vector is Apex Fusion's UTXO-based L2 blockchain, running with Cardano's mainnet parameters. It provides near-instant finality and 4x Cardano throughput, making it ideal for AI agent interactions.
- **Explorer:** https://vector.testnet.apexscan.org
- **Apex Fusion:** https://apexfusion.org