exascale.build
api ↗Connect

Docs → API reference

Power Interconnection Queue (SPP) API v1

Generated from core.contract.describe_power_interconnection_queue_spp_v1() and checked fixture-backed examples. Do not hand-edit the example JSON files.

Capability

What It Can Answer

Represented Facts

Data Point Contract

Does not answer:

REST Surface

MCP Surface

Local MCP Setup

Some MCP clients launch servers from the user's home directory or ignore a configured cwd. Use uv run --directory so the server always starts from the repository project.

{
  "command": "uv",
  "args": [
    "run",
    "--directory",
    "/absolute/path/to/OSINT",
    "python",
    "-m",
    "core.mcp_server"
  ]
}

Leave EXASCALE_PARQUET_BASE / EXASCALE_RAW_BASE unset: the one server hosts every data point's tools, and with no override it resolves each block's promoted snapshots and raw archive from the repository layout. Setting either env var points ALL tools at one directory — a per-block path breaks every other block's tools. They exist only for single-source sandboxes and tests.

Request Schema

Filters:

Group by:

Date range parameters:

Controls:

Ranking (how order_by / top_n / order join — order_by ranks groups by a metric, never a group_by dimension; top_n needs both a group_by and an order_by):

{
  "no_ranking": "Omit order_by and top_n to return all groups in group-key order.",
  "order": {
    "default": "desc",
    "valid_values": [
      "desc",
      "asc"
    ]
  },
  "order_by": {
    "accepts": "one of output.metrics",
    "note": "Ranks the groups by a metric (a measure). Not a group_by dimension \u2014 rows already come back grouped by each group_by field.",
    "requires": [
      "group_by"
    ],
    "valid_values": [
      "capacity_mw",
      "source_record_count"
    ]
  },
  "top_n": {
    "note": "Keeps the top N groups by order_by; the rest fold into one (other) remainder (additive metrics sum into it, non-additive ones are nulled) so the result still reconciles to summary.totals.",
    "requires": [
      "group_by",
      "order_by"
    ],
    "type": "positive integer"
  }
}

Output Schema

Aggregate metrics:

Metric groups:

{
  "records": [
    "source_record_count"
  ],
  "requested_mw": [
    "capacity_mw"
  ]
}

Response summary fields:

Accepted fact policy:

Metric metadata:

Metric Category Unit Aggregation Additive Across Groups Authoritative Total Definition
capacity_mw requested_mw MW sum true summary.totals.capacity_mw The project's requested interconnection capacity in MW, as SPP reports it (the Capacity column — SPP's headline MW figure).
source_record_count records count count source records true summary.totals.source_record_count Count of SPP GI queue rows in the current result scope (one atom = one project row).

Rollup rules:

Detail record fields returned when include_records is true:

Row-level citation fields:

Aggregate citation fields:

Codebooks

Field Coverage Codes Examples Note
native_status the status values observed in the SPP snapshot (live; SPP may add more) 12 WITHDRAWN = Withdrawn — left the queue (the dominant class, ~66%), IA FULLY EXECUTED/ON SCHEDULE = Interconnection Agreement signed, on schedule, IA FULLY EXECUTED/COMMERCIAL OPERATION = IA signed, in commercial operation, IA FULLY EXECUTED/ON SUSPENSION = IA signed, suspended, IA PENDING = Interconnection Agreement not yet executed ALWAYS scope by native_status. Served VERBATIM (never mapped to a lifecycle enum, never a derived active/withdrawn boolean — that equivalence is the analyst's). ~66% of rows are WITHDRAWN. A queue-MW total is REQUESTED capacity, never built — for built/operating capacity use query_power_capacity_v1. Filter by SPP's EXACT string.
generation_type the distinct generation types served from the SPP snapshot 0 SPP's own values, served verbatim — e.g. Wind, Solar, Battery/Storage, Thermal, Hybrid, Hydro. SPP encodes hybrids NATIVELY as Hybrid (no is_hybrid is invented). SPP's own case inconsistencies (WIND/wind vs Wind) are surfaced as-reported, not normalized. Filter by SPP's EXACT value.
fuel_type the distinct fuel-type strings served from the SPP snapshot 0 Free-text and often blank; slash-delimited combos (e.g. Solar/Storage, Wind/Storage) are kept WHOLE, never split. Filter by SPP's EXACT string.
service_type the distinct service types served from the SPP snapshot 0 SPP's request service type, e.g. ER/NR (Energy Resource / Network Resource), ER, NR. Filter by SPP's EXACT value.
current_cluster the distinct clusters served from the SPP snapshot 0 SPP's study cluster, e.g. DISIS-2024-001, Surplus, RTOE Transitional Cluster (blank for un-clustered rows). Filter by SPP's EXACT value.
cluster_group the distinct cluster groups served from the SPP snapshot 0 SPP's regional cluster group, e.g. 01 NORTH, 02 NEBRASKA, 03 CENTRAL, 04 SOUTHEAST, 05 SOUTHWEST. Filter by SPP's EXACT value.

The complete machine-readable codebooks are included in capability-schema.json.

Checked Examples

Agent question Request params Checked output
How much requested capacity and how many rows sit in the SPP queue, by SPP's native status? {"group_by": ["native_status"]} spp-queue-by-status.json
What generation types lead SPP's DISIS-stage study requests, by requested MW? {"group_by": ["generation_type"], "native_status": "DISIS STAGE", "order_by": "capacity_mw", "top_n": 5} disis-by-gentype.json
Which SPP states have the most requested interconnection capacity in the study pipeline? {"group_by": ["state"], "native_status": "DISIS STAGE", "order_by": "capacity_mw", "top_n": 10} requested-mw-by-state.json
Return one SPP DISIS-stage queue project with a row-level citation. {"include_records": true, "limit": 1, "native_status": "DISIS STAGE"} queue-detail-with-citation.json
Verify the raw workbook row behind a returned citation citations[ref].verify (aggregate) or records[0].citation (detail) source-row-evidence.json
Dogfood the tool sequence as an agent list -> describe -> query -> evidence agent-dogfood-transcript.json

The checked schema output is capability-schema.json.

Agent Workflow

  1. Call list_capabilities_v1 and select power.interconnection_queue_spp.
  2. Call describe_power_interconnection_queue_spp_v1 to inspect valid filters, groupings, metrics, and citation fields.
  3. Call query_power_interconnection_queue_spp_v1 with bounded JSON params.
  4. If the answer needs proof, pass a returned row-level citation object to get_source_evidence_v1.
  5. Answer with the resolved as_of and relevant citations. Present returned metrics as authoritative for their declared source, snapshot, grain, and aggregation.
Generated from the tested API contract. Compare with the live capability map ↗