McpServerOptions
#Public declaration. Read the signature and member contracts below; no additional behaviour is inferred.
import type { McpServerOptions } from '@insiderfinance/totalfinance-mcp';
export interface McpServerOptions {
/** Task selection when neither tools nor packs is supplied. Explicit tools/packs remain exact. */
profile?: RegistryProfile;
/** Maximum entries per tools/resources list page: integer 1–100, default 100. */
pageSize?: number;
/** Explicit local worker runner; requires its artifact reader. Adds typed job controls, never grants. */
jobs?: JobRunner;
/**
* An artifact store (Decision 5): input handles resolve through it; permitted reports are listed
* as `totalfinance://reports/<hash>` resources. With jobs attached, reports for excluded operations
* are hidden. A constructor argument — nothing is looked up by "current session".
*/
artifacts?: ArtifactStoreReader;
/** Override the default tool set with an explicit list (the low-level escape hatch). */
tools?: TotalFinanceTool[];
/**
* EXACT pack selection (alignment spec P1.1): omitted → the selected profile; provided → exactly
* the packs given, nothing implicit. `packs: [optionsPack()]` exposes only the option tools;
* expand the defaults with `packs: [...defaultPacks(), backtestPack()]`. When `tools` is also
* given, the registry is their union (both are explicit). Pack tools obey the same read-only
* filter, seed policy, and budgets as the defaults.
*/
packs?: (ToolPack | OperationPack)[];
/**
* Reject any tool call whose serialized arguments exceed this many bytes (compute-budget guard,
* spec §18.5). Default 64 KB.
*/
maxInputBytes?: number;
/**
* Financial read-only mode (default `true`): tools flagged `mutates` or requiring a write/approval
* capability are filtered out. Explicit artifact storage and job controls are independent.
*/
readOnly?: boolean;
/** What every caller of this server holds (Stage 7B.2 Decision 9); default the runtime's defaults. */
capabilities?: readonly string[];
/** The trade lifecycle's stores (Decision 10). */
stores?: {
authorization?: AuthorizationStore;
journal?: ExecutionJournalStore;
};
/** The instant stamped on a stored result's handle when `artifacts` is writable — the edge's clock (default `new Date().toISOString()`). */
clock?: () => string;
/**
* Deterministic seed policy (spec §18.5). Any stochastic CALL (Monte Carlo, resampling — a tool's
* `stochastic` flag may be a per-call predicate) requires a seed; when absent, this default is
* injected and echoed in `structured.assumptions.seed` so MCP results are reproducible. Default 0.
* Deterministic calls (e.g. historical/parametric VaR) never get a meaningless seed injected.
*/
defaultSeed?: number;
/** Soft wall-clock budget per tool call (ms). A call exceeding it returns an error. */
deadlineMs?: number;
}Fields, parameters and returned members (157)
Loading 157 members…
Stability: preview (pre-1.0). Units come from declared names; “unitless by name” means the name alone does not establish a unit. See conventions and errors and warnings.