Getting Started - UnitBuilds-CC/V.E.L.O.C.I.T.Y.-MCP GitHub Wiki

Getting Started

Prerequisites

  • Rust toolchain (rustc 1.70+, cargo) — Install via rustup
  • Windows, Linux, or macOS — Cross-platform support

Install from Binary

# Linux/macOS
curl -L https://github.com/UnitBuilds-CC/V.E.L.O.C.I.T.Y.-MCP/releases/latest/download/velocity_mcp -o velocity_mcp
chmod +x velocity_mcp
sudo mv velocity_mcp /usr/local/bin/

# Windows
curl -L https://github.com/UnitBuilds-CC/V.E.L.O.C.I.T.Y.-MCP/releases/latest/download/velocity_mcp.exe -o velocity_mcp.exe

Build from Source

git clone https://github.com/UnitBuilds-CC/V.E.L.O.C.I.T.Y.-MCP.git
cd V.E.L.O.C.I.T.Y.-MCP

# Release build (optimized)
cargo build --release

# Run tests (284)
cargo test --all-features

# Run benchmarks
./target/release/velocity_mcp --benchmark

Run the Server

Stdio Mode (MCP Clients)

velocity_mcp --mode stdio

Compatible with Claude Desktop, Cursor, and other MCP clients.

HTTP Mode (Web/SDKs)

velocity_mcp --mode http --addr 0.0.0.0:3000

Endpoints: /mcp (JSON-RPC), /sse (SSE), /ws (WebSocket), /metrics (Prometheus), /health

Shared Memory Mode (Ultra-low latency)

velocity_mcp --mode shmem --buffer-path nmcp_buffer.bin

Configure MCP Clients

Claude Desktop

Edit %APPDATA%\Claude\claude_desktop_config.json:

{
  "mcpServers": {
    "velocity-mcp": {
      "command": "C:\\path\\to\\velocity_mcp.exe",
      "args": ["--mode", "stdio"]
    }
  }
}

Cursor

Add to .cursor/mcp.json:

{
  "mcpServers": {
    "velocity-mcp": {
      "command": "/path/to/velocity_mcp",
      "args": ["--mode", "stdio"]
    }
  }
}

Using Client SDKs

# Python
from velocity_mcp import Client
client = Client("http://localhost:3000")
tools = client.list_tools()

See Client-SDKs for all 4 languages.

Docker

docker pull unitbuilds/velocity-mcp:latest
docker run -p 3000:3000 unitbuilds/velocity-mcp:latest

CLI Options

Flag Description Default
--mode <stdio|http|ws|shmem> Transport mode stdio
--addr <address> HTTP/WS listen address 0.0.0.0:3000
--config <path> TOML config file —
--buffer-path <path> Shmem buffer file nmcp_buffer.bin
--benchmark Run benchmarks —

Next Steps

V.E.L.O.C.I.T.Y. MCP Server v3.0.0 | MIT / Apache 2.0 | UnitBuilds

⚠️ **GitHub.com Fallback** ⚠️