mineryield-mcp

MinerYield is for home miners and small businesses with solar and battery in the numbers. This MCP server (and the hosted endpoint at https://mineryield.com/mcp) exposes the same leftover-watt solar / battery / grid model the site calculator already uses. Tools call https://mineryield.com/api/v1/**. They do not reimplement profitability math.

Ask an assistant:

• "I have a 10 kW solar array and a 20 kWh battery, which miner makes the most per day?"

• "a 3 kW miner on solar by day, grid at $0.15/kWh at night"

list_miners answers the first (optional solarW=10000, batteryCapacity=20, sort PROFIT/DAY). calculate_profitability answers the second (power=3000, elecCost=0.15, powerSources={solar:true, battery:false, grid:true}).

Figures are model estimates from live market and weather inputs. They are estimates only, not investment, financial, or tax advice, not ROI guarantees, and not hardware telemetry. Results vary with network difficulty, coin price, power cost, and hardware performance. Do your own research.

Admin routes (/api/v1/admin/*) are not exposed.

Requirements: Node.js 22 or newer.

Hosted endpoint: https://mineryield.com/mcp (Streamable HTTP, Authorization: Bearer <key>). Setup page: mineryield.com/ai/.

Registry name: io.github.nadeaup/mineryield-mcp

What's supported (existing site calculator)

No new calculation logic. These are the site calculator inputs the tools already forward:

On GET /api/v1/miners / list_miners, query values override the API-key owner profile. Sending solarW without solar=false turns solar on; sending batteryCapacity without battery=false turns battery on.

get_solar_forecast is weather-based array production only (zipCode + capacityW). Pair it with list_miners or calculate_profitability for miner profit.

Related MCP server: PVGIS MCP

API key

Create a Bearer API key while signed in at mineryield.com/api. Set it as MINERYIELD_API_KEY. Never commit it.

Optional: MINERYIELD_API_BASE_URL (defaults to https://mineryield.com).

Setup walkthrough: Use MinerYield in your AI assistant.

npx (recommended)

export MINERYIELD_API_KEY="your-key"
npx -y mineryield-mcp

Local Streamable HTTP (for debugging a hosted-style client):

npx -y mineryield-mcp --http --port 3333

npm package

npm install -g mineryield-mcp
export MINERYIELD_API_KEY="your-key"
mineryield-mcp

From this repository:

npm install
npm run build
export MINERYIELD_API_KEY="your-key"
npm start

Claude Desktop

Add to claude_desktop_config.json (Claude → Settings → Developer):

{
  "mcpServers": {
    "mineryield": {
      "command": "npx",
      "args": ["-y", "mineryield-mcp"],
      "env": {
        "MINERYIELD_API_KEY": "your-key"
      }
    }
  }
}

Or connect Claude to the hosted endpoint https://mineryield.com/mcp with Authorization: Bearer your-key.

Cursor

This repository also ships .cursor-plugin/plugin.json and a root mcp.json (runs npx -y mineryield-mcp).

Published package / npx snippet for Cursor MCP settings:

{
  "mcpServers": {
    "mineryield": {
      "command": "npx",
      "args": ["-y", "mineryield-mcp"],
      "env": {
        "MINERYIELD_API_KEY": "your-key"
      }
    }
  }
}

Hosted Streamable HTTP:

{
  "mcpServers": {
    "mineryield": {
      "url": "https://mineryield.com/mcp",
      "headers": {
        "Authorization": "Bearer your-key"
      }
    }
  }
}

ChatGPT and other MCP clients

Use Streamable HTTP:

• URL: https://mineryield.com/mcp

• Auth: Authorization: Bearer <MINERYIELD_API_KEY>

• Discovery: https://mineryield.com/.well-known/mcp.json

ChatGPT (Connectors / custom MCP), Claude remote MCP, and Grok custom connectors all accept that URL plus the Bearer header. Public tools still require the key on the hosted endpoint so per-key rate limits and quotas apply.

OpenAPI remains the HTTP contract: mineryield.com/swagger.yaml.

Tools

calculate_profitability body

Matches POST /api/v1/calculator in the OpenAPI spec:

API-key management (not a tool)

GET / POST / DELETE /api/v1/api-keys require a Firebase ID token from a signed-in browser session, not the Bearer API key. Creating or revoking keys from an agent is not part of this default tool set. Use the site at /api.

Example prompts

• "I have a 10 kW solar array and a 20 kWh battery, which miner makes the most per day?"

• "a 3 kW miner on solar by day, grid at $0.15/kWh at night"

• "List MinerYield catalog ASICs and show name, algorithm, hashrate, and watts."

• "Estimate daily profit for a 200 TH/s, 3500 W SHA-256 miner at $0.12/kWh with 10 kW solar in ZIP 10001. This is a model estimate, not a guarantee."

• "Estimate daily profit for a Bitmain KA3 (166 TH/s Kadena) at $0.12/kWh."

• "Calculate SHA-256 profitability for 200 TH/s with preferredCoin QUAI."

• "What are the current MinerYield spot prices for BCH, KAS, ETC, XMR, and QUAI?"

• "Get a 7-day difficulty prediction for KDA."

• "Get a 7-day solar forecast for ZIP 85001 with a 8 kW array."

• "Show my saved MinerYield rigs and their estimated daily profit."

Tests

npm install
npm test

Hosted Streamable HTTP

Production endpoint: https://mineryield.com/mcp

Bearer API-key auth uses the same key store as /api/v1. Admin routes and tools are not mounted. Per-key and per-IP rate limits apply at this surface; tool calls then consume the usual monthly API quota on the REST API.

Discovery:

• https://mineryield.com/llms.txt

• https://mineryield.com/.well-known/mcp.json (same document as /mcp-discovery.json)

• https://mineryield.com/ai/

License

MIT