Deal Ledger
32 entities and 117 agent-callable operations in sf_ops. Each operation is addressed as {mega_tool}/sf_ops/{entity}/{operation} and carries the same permission check over MCP and REST.
117 of 117 shown
calendar
| Operation | Mega-tool | What it does |
|---|---|---|
list | report_query | Dated obligations of one deal (or, with deal_key omitted, every deal you may see): payment dates, reports due, notices due, tests and milestones. |
materialize | smart_action | Reconcile the caller organization's Deal Ledger calendar: expand every deal's current payment_schedule and due_within slots into dated SfObligationEvent rows… |
preview_ics | report_query | Preview the calendar file (ICS) a subscription would serve you: one deal (deal_key) or every deal you can see (deal_key omitted), the first 50 events in… |
triggered_notices | report_query | The triggered-notice playbook of one deal: every notice the indenture requires after an event (Event of Default, redemption, rating action …), whether or not… |
calendar_subscription
| Operation | Mega-tool | What it does |
|---|---|---|
create | smart_action | Create your own calendar subscription (ICS link) for one deal's dated obligations, or for every deal you can see (deal_key omitted). |
revoke | smart_action | Stop one of your calendar subscriptions for good. |
rotate | smart_action | Replace the link of one of your calendar subscriptions; the old link stops working at once. |
cashflow_backtest
| Operation | Mega-tool | What it does |
|---|---|---|
get | report_query | One stored back-test: its score, tolerance, gates and per-figure differences. |
list | report_query | The stored back-tests of the model against trustee-reported figures for this deal (tier A: one period from the reported start; B: multi-period; C… |
run | smart_action | Score the model against trustee-reported figures. |
cashflow_binding
| Operation | Mega-tool | What it does |
|---|---|---|
list | report_query | The operator bindings on this deal's cash-flow model: each binding's target, value, note, the assertion it cites and whether it is current… |
retire | smart_action | Retire a current binding so the step goes back to what the ledger compiles. |
set | smart_action | Bind one waterfall step (or class, coupon, fee, test, term) the cash-flow engine could not model from the ledger, so the projection can move its money. |
cashflow_model
| Operation | Mega-tool | What it does |
|---|---|---|
compile_report | report_query | How much of this deal's payment waterfall the cash-flow engine could compile from the ledger: every step with its status (compiled / bound / unmodelled), the… |
steps | report_query | The deal's compiled waterfall steps, in payment order, each with its clause citations and how it was compiled (ledger or operator binding). |
cashflow_run
| Operation | Mega-tool | What it does |
|---|---|---|
breakeven | smart_action | Find the driver value at which a class first takes a loss (or first misses an interest payment): the break-even CDR, recovery, and so on, bracketed and solved… |
compare | report_query | Compare cashflow run. |
execute | smart_action | Project one scenario through the deal's compiled waterfall: per-class interest, principal, loss and WAL, the first shortfall, and the assumptions used (each… |
explain | report_query | Why one number in a stored projection is what it is: the waterfall steps that produced class_key's metric in one period, with the available cash before and… |
export | report_query | A short-lived DOWNLOAD TICKET for a run's workbook (xlsx) or csv — never the file itself. |
get | report_query | One stored cash-flow run: its summary per class (interest, principal, loss, WAL, first shortfall / first loss), the assumptions it used, and ONE PAGE of… |
grid | smart_action | Sweep one or two scenario drivers (e.g. |
list | report_query | The deal's stored cash-flow runs the caller may read (a run built from a document the caller cannot see is omitted), newest first, without their period rows. |
cashflow_scenario
| Operation | Mega-tool | What it does |
|---|---|---|
create | entity_crud | Save a new cash-flow scenario for a deal (version 1). |
delete | entity_crud | Retire a scenario: it leaves the current list, and its version stays for the runs that cite it. |
get | entity_crud | One cash-flow scenario by id: its name, version, whether it is a preset, whether it is the current version, and its body. |
list | entity_crud | The cash-flow scenarios available for a deal: the platform presets, org templates and the deal's own, current versions only (include_retired=true adds… |
update | entity_crud | Save a NEW VERSION of a scenario: the version named by id stays as it was (runs that used it keep citing it) and stops being current. |
collateral_tape
| Operation | Mega-tool | What it does |
|---|---|---|
get | report_query | One collateral tape: its header, column mapping and refusals, and ONE PAGE of its positions. |
import | smart_action | Import a collateral tape and make it the deal's current tape. |
list | report_query | The collateral tapes imported for this deal that the caller may see (a tape from a trustee document the caller cannot see is absent), newest first, without… |
preview | smart_action | Preview a collateral tape import WITHOUT storing anything: the detected columns, the mapping, a mapped sample, per-row refusals and a one-sentence summary… |
use_repline | smart_action | Switch the deal's collateral back to the representative line: no tape stays current (tapes are kept, never deleted), so later runs project from the rep-line… |
consistency_finding
| Operation | Mega-tool | What it does |
|---|---|---|
file | smart_action | File a non-adjudicated consistency finding (from deal/consistency_check) as a governed conflict-review task — a ConflictSet + one ConflictMembership per… |
coverage_test
| Operation | Mega-tool | What it does |
|---|---|---|
evaluate | smart_action | Record one measured value for a coverage test and compute its pass/fail verdict, through the shared covenant engine. |
set_threshold | smart_action | Record an operator's decomposition of a coverage test's printed required ratio, for a test whose printed text could not be parsed into a number (e.g. |
status | report_query | Per-class coverage-test status for one deal, computed from the accepted definition: the numerator, denominator, exclusions and required ratio each traced to… |
deal
| Operation | Mega-tool | What it does |
|---|---|---|
all_terms | report_query | Every extracted fact the ledger holds an opinion about for one deal: one row per current, contested or superseded slot candidate, plus one row per resolver… |
amendment_chain | report_query | The deal's instrument chain on its own: the base indenture, every accepted supplemental indenture and amended-and-restated indenture, ordered by chain depth… |
amendment_diff | report_query | What changed in a supplemental indenture or amended and restated indenture, slot by slot, against the instrument it amends. |
clause_coverage | report_query | The Deal Ledger twin of structure_ledger/clause_coverage/summary: resolves deal_key to its chain's (visible) instruments' primary source versions, and reports… |
compare | report_query | Cross-deal comparison matrix: every comparable slot across N deals of the caller's organization and one namespace, aligned onto a mechanical, declared… |
consistency_check | report_query | Is this indenture internally consistent, and how much of it did we actually check? |
current_state | report_query | The Deal Ledger's current-state read: every slot of one deal's indenture chain (base indenture plus every accepted supplemental indenture / amended and… |
documents | report_query | Deal Ledger screen: the Documents screen: every document the indenture references, its attachment state, completeness, and the 'not stated' table of accepted… |
evidence | report_query | The evidence chip's fetch: every EvidenceRef for one accepted assertion — the clause anchor, section number, page, the phrase as printed, and the… |
evidence_preview | report_query | The evidence preview for one Deal Ledger chip: the quoted language with its surrounding context, and where it sits. |
layout | report_query | One Deal Ledger deal's TYPE and the layout it selects. |
list | report_query | The Deal Ledger's deal index: every deal (indenture, supplemental indenture, amended and restated indenture chain) the caller's organization holds, with an… |
notes | report_query | Deal Ledger screen: the Notes screen: every issued class — designation, form, seniority rank and what it ranks senior to, coupon basis, original principal… |
obligations | report_query | Deal Ledger screen: the Obligations & Deadlines screen: every duty grouped by obligation subject (obligor, obligee, due-within deadline, recurrence), plus the… |
parties | report_query | Deal Ledger screen: the Parties screen: every party, its role, capacity, attribution basis, successor-of chain, and any removal right naming that role; plus… |
structure | report_query | The structure ledger of each of a deal's ledger instruments, in chain order — the same payload as instrument/structure per instrument (receipt, history… |
structure_edges | report_query | One page of structure-ledger edges for ONE of a deal's ledger instruments. |
summary | report_query | Deal Ledger screen: the Deal screen: the instrument chain (base indenture plus every accepted supplemental/amended-and-restated indenture), periods, amendment… |
tests | report_query | Tests deal. |
waterfall | report_query | Deal Ledger screen: the Waterfall screen: every payment rung grouped by waterfall kind and ordered by rank, with what it pays, what test it cures, its expense… |
deal_event
| Operation | Mega-tool | What it does |
|---|---|---|
record | smart_action | Record one deal event from its source document and date the notices the indenture requires after it. |
deal_sequence
| Operation | Mega-tool | What it does |
|---|---|---|
create | smart_action | Create version 1 of a DealSequence — a named, ordered list of instruments (CROSS_DEAL_SYNTHESIS_EVALUATIONS_DESIGN.md §3.1). |
get | report_query | One DealSequence's full ordered member list (§3.1). |
list | report_query | List the organization's DealSequences — the ordering/scope objects a cross-deal synthesis pins (CROSS_DEAL_SYNTHESIS_EVALUATIONS_DESIGN.md §3.1). |
set_members | smart_action | Version an existing DealSequence — append-only (§3.1): inserts version n+1 with supersedes=n and flips n to is_current=False; NEVER edits a version in place. |
deal_type
| Operation | Mega-tool | What it does |
|---|---|---|
propose | smart_action | Classify Deal Ledger deals by type (CLO / CMBS / RMBS / ABS, plus subtype) with the closed deterministic rule set, citing >= 2 accepted defined-term facts per… |
distribution_report
| Operation | Mega-tool | What it does |
|---|---|---|
backfill | smart_action | Ingest EVERY available monthly 10-D distribution report of one registered CMBS trust, oldest first, as Control Termination Event coverage-test readings — the… |
filer_disable | smart_action | Disable a deal's 10-D filer for the caller's organization: the daily poll skips it and ingest/backfill refuse filer_disabled. |
filer_register | smart_action | Register (or re-enable and update) a deal's 10-D filer for the caller's organization, so the daily poll and the backfill cover it without a code deploy. |
filers | report_query | The caller's organization's registered 10-D filers — the CMBS trusts whose monthly distribution reports the daily poll reads from SEC EDGAR. |
ingest | smart_action | Read one monthly distribution report of a registered CMBS trust from SEC EDGAR and record it as a coverage-test reading for the trust's Control Termination… |
list | report_query | The monthly distribution reports a registered CMBS trust has filed on SEC EDGAR, newest first: per period, the 10-D (its EX-99.1 is the certificate… |
poll | smart_action | Poll every ENABLED 10-D filer of the caller's organization for new monthly distribution reports and record each new period as a Control Termination Event… |
filing
| Operation | Mega-tool | What it does |
|---|---|---|
census | smart_action | Measure the clause-anchor mint of one registered filing job without minting: units, levels, Articles (l1), distinct/duplicate sections, numbered level-3… |
ingest | smart_action | Ingest filing. |
mint | smart_action | Mint clause anchors for one censused filing job, in a Celery task and one atomic transaction (an interrupted mint writes nothing). |
plan | smart_action | Plan a by-accession ingest of public EDGAR filings into the Deal Ledger (sf_public org only). |
status | smart_action | Read Deal Ledger filing-ingest jobs, including their stage log, lease, soft ids and refusal receipts {code, stage, message, retryable, accession, component… |
harness
| Operation | Mega-tool | What it does |
|---|---|---|
scorecard | report_query | The latest (or one named) sf_question_harness receipt for one deal: the 27-question regression set (regression27, the default — a usage log plus example bank)… |
instrument
| Operation | Mega-tool | What it does |
|---|---|---|
list | report_query | List instrument. |
structure | report_query | Structure instrument. |
structure_edges | report_query | One instrument's structure-ledger edges (cross-references and defined-term uses), paginated, with counts_by_kind over the full filtered set. |
structure_node | report_query | One structure-ledger node in full: its tree fields, coverage state, breadcrumb (ancestors), direct children, host node, enumerator map, edge counts and its… |
namespace
| Operation | Mega-tool | What it does |
|---|---|---|
declare_default | smart_action | Declare or clear the caller organization's default Deal Ledger namespace: the namespace every Deal Ledger read and write uses when the org claims more than… |
obligation_event
| Operation | Mega-tool | What it does |
|---|---|---|
complete | smart_action | Mark one dated obligation of a deal done (a payment made, a report or notice delivered). |
dismiss | smart_action | Dismiss one dated obligation that does not apply (e.g. |
set_date | smart_action | Confirm or correct the due date of one dated obligation (e.g. |
upcoming | report_query | The Deal Ledger obligation ladder: everything due within the next N days across the caller organization's materialized calendar, due-date ordered, with the… |
obligation_rules
| Operation | Mega-tool | What it does |
|---|---|---|
query | report_query | The sf_ops rule registry (E-19 clause 4): every ENABLED-or-DISABLED HEAD rule the shared obligation engine is registered to run for the Deal Ledger calendar. |
performance
| Operation | Mega-tool | What it does |
|---|---|---|
payments_over_time | report_query | What one deal paid across its report dates: per-class interest paid, principal paid, ending balance and deferred interest; waterfall step amounts; and holder… |
tests_over_time | report_query | Coverage and quality tests of one deal across its report dates, as printed by the trustee and computed by the platform. |
periodic_report
| Operation | Mega-tool | What it does |
|---|---|---|
detail | report_query | Everything one deal's report said on one report date. |
extract | smart_action | Read the figures of one registered periodic report with its layout spec. |
harvest_10d | smart_action | Harvest per-class figures from a public deal's 10-D distribution statements (EX-99.1) already in the organization's filing cache. |
list | report_query | The reports tracker of one deal: every expected report (from the indenture reading) and every received one, newest first. |
register | smart_action | Register one received periodic report of a deal (the one register door). |
sync | smart_action | Backfill the reports tracker from what the platform already holds: every document registered as a trustee report and every recorded 10-D reading that has no… |
public_filing
| Operation | Mega-tool | What it does |
|---|---|---|
ingest | smart_action | Register and read one PUBLIC filing about a deal. |
reported_value
| Operation | Mega-tool | What it does |
|---|---|---|
entry_grid | report_query | The manual-entry grid of one registered report: every metric this deal's reports carry (from its other report dates and its ledger coverage tests), with this… |
evidence | report_query | Where one reported figure or event was printed: the report document, page, table row and column, the exact quote with its surrounding text, and the highlight… |
promote | smart_action | Promote a report's printed coverage-test results to readings on the deal's ledger tests (Phase 1 record_reading, cited to the report line). |
record | smart_action | Record figures read off one registered report, each cited to its page. |
series | report_query | One reported metric of one deal across its report dates. |
saved_view
| Operation | Mega-tool | What it does |
|---|---|---|
create | entity_crud | Save the current All-deals filter/columns/sort as a named view |
delete | entity_crud | Delete an All-deals saved view you own |
get | entity_crud | Get one All-deals saved view |
list | entity_crud | List All-deals saved views: the caller's own plus every view shared with the organization |
update | entity_crud | Rename, re-share or re-target an All-deals saved view you own |
slot
| Operation | Mega-tool | What it does |
|---|---|---|
compare | report_query | The drill-down for one deal/compare row: full candidate detail (current AND superseded members, every EvidenceRef) per deal for one comparison_key — never… |
list | report_query | The slot inventory for one deal: every (deal_key, predicate, discriminator) slot the resolver placed, plus every row it could not place into a slot at all (a… |
sync_run
| Operation | Mega-tool | What it does |
|---|---|---|
latest | report_query | The most recent Deal Ledger calendar materialization receipt for the caller organization — org-scoped, since one materialization run reconciles every deal at… |
task_failures
| Operation | Mega-tool | What it does |
|---|---|---|
query | report_query | Terminal failures of the Deal Ledger's obligation tasks (E-19 clause 1): every scheduled calendar-materialization run that exhausted its retry budget and gave… |
trustee_feed
| Operation | Mega-tool | What it does |
|---|---|---|
preview_match | integration_call | Preview which recently synced inbound emails are trustee-portal alerts that a new deal report was posted, and which deal and period each names. |
trustee_report
| Operation | Mega-tool | What it does |
|---|---|---|
list | report_query | The trustee reports of private structured-finance deals registered in your organization (and the organizations beneath it), newest period first. |
record_reading | smart_action | Record one coverage-test reading read by an operator from a registered, confidential trustee report, citing where in the document the number is. |
register | smart_action | Register a platform document (PDF, XLSX, XLS or CSV) as the trustee report of a private structured-finance deal for one period, so coverage-test readings can… |
view_settings
| Operation | Mega-tool | What it does |
|---|---|---|
get | config_manage | Read the ACTING user's Deal Ledger view settings for the active organization: evidence preview mode/delay, where an evidence click opens, and table density. |
reset | config_manage | Reset the ACTING user's Deal Ledger view settings to the defaults by deleting the stored row. |
schema | config_manage | The Deal Ledger view-settings schema: every field, its allowed values and its default, plus the complete default document. |
set | config_manage | Change the ACTING user's Deal Ledger view settings. |
Parameter schemas and permissions
Parameter schemas and permission codenames are in the full reference — sign in — or call prism_introspect(dimension="capability_search", query="…") with your key.
In the full reference this application appears under config_manage, entity_crud, integration_call, report_query, smart_action.