Skip to main content
Glama
Sign In

MinerYield

by io.github.nadeaup
OverviewDiscussionsAdmin

List miners

list_miners
Read-only

GET /api/v1/miners — rank catalog ASICs by daily profit for a home or small-business solar+battery+grid setup (same model as the site calculator). Optional solarW (10000=10 kW), batteryCapacity (kWh), zipCode, elecCost, and powerSources override the API-key owner profile. Example: 10 kW array + 20 kWh battery → solarW=10000, batteryCapacity=20, powerSources={solar:true, battery:true, grid:true}; sort PROFIT/DAY. Includes Kadena/KDA, NexaPow/NEXA, XPHash/XP, SHA-256 QUAI, and NiceHash daily revenue when a rate exists. Figures are MinerYield model estimates from live market inputs: estimates only, not investment, financial, or tax advice, and not ROI guarantees. Results vary with network difficulty, coin price, power cost, and hardware performance. Do your own research.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "list_miners"
  }
}

Input Schema

NameRequiredDescriptionDefault
solarWNoHome/small-business solar array capacity in Watts (10000 = 10 kW). Used with Peak Sun Hours from zipCode. Solar generation is treated as free during the sun window; leftover watts can charge the battery.
zipCodeNo5-digit US ZIP for Peak Sun Hours. Defaults to the API-key owner profile, then 06716. Needed for a realistic solar-by-day estimate.
elecCostNoGrid electricity price in USD per kWh (0.15 = 15 cents). Applied only to leftover watts after solar and battery. There is no separate day/night rate: solar covers the sun window, grid covers the rest at this price. On list_miners this overrides the API-key owner profile.
powerSourcesNoWhich legs of the site calculator to use. solar=true uses solarW during Peak Sun Hours; battery=true uses leftover solar stored in batteryCapacity at night; grid=true keeps the miner running 24h on leftover grid kWh. solar=true + grid=true + battery=false is "solar by day, grid at night". If grid=false the miner only runs while solar or battery energy lasts (runtimeHours < 24).
batteryCapacityNoBattery storage in kWh (20 = 20 kWh). Only used when powerSources.battery is true (passing batteryCapacity without powerSources turns battery on). Excess daytime solar charges the battery; the battery covers night hours before grid.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnly=true, openWorld=true, destructive=false, so the safety profile is covered. The description adds genuinely useful behavior beyond that: which input data feed the estimates, that NiceHash revenue appears only 'when a rate exists', that figures are model estimates dependent on difficulty/price/power/hardware, and the override semantics for profile values. It stops short of describing the response payload, ordering guarantees, or result size, which matters for a ranked list with no output schema.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The single paragraph is front-loaded with the endpoint, verb, and resource, followed by parameter override behavior and the example, which is a sensible order. However, the coin ticker roster ('Kadena/KDA, NexaPow/NEXA, XPHash/XP, SHA-256 QUAI') and the lengthy disclaimer tail ('estimates only, not investment... Do your own research') consume substantial space without helping tool selection or invocation.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a read-only, five-optional-parameter tool with a nested object and no output schema, the description supplies the model context, an end-to-end parameter example, data sources, and caveats, which is close to sufficient. The remaining gap is what the ranked result actually looks like (fields, count, ordering controls) since no output schema exists to cover it.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3 and the description largely restates what the schema documents (solarW, batteryCapacity, powerSources, zipCode, elecCost). The concrete mapping example ('10 kW array + 20 kWh battery → solarW=10000, batteryCapacity=20, powerSources=...') and the PROFIT/DAY sort hint do add real interpretive value, but they are not enough to lift this above the baseline for parameters the schema already fully explains.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with a specific verb and resource ('rank catalog ASICs by daily profit') and scopes it to a home/small-business solar+battery+grid scenario, which is far more informative than the title 'List miners'. It never names a sibling such as list_catalog_miners or calculate_profitability, so the agent must infer the boundary from behavior alone rather than from an explicit contrast.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is only implied through the scenario framing ('home or small-business solar+battery+grid setup', 'same model as the site calculator') and the note that optional params override the API-key owner profile. There is no explicit when-to-use/when-not statement and no signposting toward the calculator or catalog siblings, so an agent cannot cleanly decide between this tool and its neighbors.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All MinerYield toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources