The finance developer workbenchSearch the reference Development · 0.1.4 · unpublished

Public API / @insiderfinance/totalfinance-mcp

@insiderfinance/totalfinance-mcp

import from '@insiderfinance/totalfinance-mcp'

Every public export in this entry point, including type-only declarations. Search by name or concept.

Jump to an export (28)

McpServerOptions · ToolPack · ToolResult · TotalFinanceTool · analysisTools · artifactPack · backtestPack · calendarPack · createTotalFinanceMcpServer · cryptoPack · defaultPacks · defaultTools · defineTool · fixedIncomePack · journeyPacks · optionsPack · performancePack · portfolioPack · researchPack · riskPack · scenarioPack · strategyPack · structurePack · technicalAnalysisPack · toolFromOperation · toolNameFor · valuationPack · volatilityPack

interface

McpServerOptions

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

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 & returned members (157)

This large namespace is split into complete field pages. No fields are omitted.

Stability, warnings & conventions
preview (pre-1.0)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

interface

ToolPack

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export interface ToolPack {
    name: string;
    tools: TotalFinanceTool[];
}
Fields, parameters & returned members (2)
Name / typeMeaning & unitOptional / default
name
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
tools
TotalFinanceTool[]
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
preview (pre-1.0)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

interface

ToolResult

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export interface ToolResult {
    /** Human-readable one-line summary. */
    summary: string;
    /** Machine-readable structured output (returned as MCP `structuredContent`). */
    structured: Record<string, unknown>;
}
Fields, parameters & returned members (2)
Name / typeMeaning & unitOptional / default
structured
Record<string, unknown>		Machine-readable structured output (returned as MCP `structuredContent`).
unitless by name		Required / declared member
No @default declared; consult the signature and description.
summary
string		Human-readable one-line summary.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
preview (pre-1.0)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

interface

TotalFinanceTool

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export interface TotalFinanceTool {
    name: string;
    title: string;
    description: string;
    schema: Schema<unknown>;
    /**
     * JSON Schema describing the structured output (the `structured` slot). On the wire every
     * tool's `outputSchema` is the full `OperationResult` envelope wrapping this schema.
     */
    outputSchema?: JSONSchema;
    /** Whether the tool mutates state (filtered out in read-only mode). Default `false`. */
    mutates?: boolean;
    /**
     * Whether a call draws random samples, so the server's deterministic seed policy applies (inject
     * the default seed when absent; echo it in `structured.assumptions.seed`). `true` = every call;
     * a predicate = per-call (e.g. VaR is stochastic only for `method: 'monteCarlo'`). Default `false`.
     */
    stochastic?: boolean | ((args: Record<string, unknown>) => boolean);
    run(input: unknown): ToolResult;
}
Fields, parameters & returned members (143)
Name / typeMeaning & unitOptional / default
description
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
mutates
boolean		Whether the tool mutates state (filtered out in read-only mode). Default `false`.
unitless by name		Optional
No @default declared; consult the signature and description.
name
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
outputSchema
JSONSchema		JSON Schema describing the structured output (the `structured` slot). On the wire every tool's `outputSchema` is the full `OperationResult` envelope wrapping this schema.
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.$id
string
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.$schema
string
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.additionalProperties
boolean | JSONSchema
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.additionalProperties.$id
string
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.additionalProperties.$schema
string
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.additionalProperties.additionalProperties
boolean | JSONSchema
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.additionalProperties.allOf
JSONSchema[]
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.additionalProperties.anyOf
JSONSchema[]
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.additionalProperties.const
unknown
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.additionalProperties.default
unknown
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.additionalProperties.description
string
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.additionalProperties.enum
unknown[]
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.additionalProperties.exclusiveMaximum
number
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.additionalProperties.exclusiveMinimum
number
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.additionalProperties.format
string
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.additionalProperties.items
JSONSchema
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.additionalProperties.maxItems
number
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.additionalProperties.maxLength
number
count (integer)		Optional
No @default declared; consult the signature and description.
outputSchema.additionalProperties.maximum
number
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.additionalProperties.minItems
number
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.additionalProperties.minLength
number
count (integer)		Optional
No @default declared; consult the signature and description.
outputSchema.additionalProperties.minimum
number
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.additionalProperties.multipleOf
number
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.additionalProperties.oneOf
JSONSchema[]
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.additionalProperties.pattern
string
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.additionalProperties.properties
Record<string, JSONSchema>
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.additionalProperties.required
string[]
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.additionalProperties.title
string
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.additionalProperties.type
import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.allOf
JSONSchema[]
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.anyOf
JSONSchema[]
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.const
unknown
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.default
unknown
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.description
string
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.enum
unknown[]
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.exclusiveMaximum
number
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.exclusiveMinimum
number
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.format
string
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.items
JSONSchema
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.maxItems
number
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.maxLength
number
count (integer)		Optional
No @default declared; consult the signature and description.
outputSchema.maximum
number
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.minItems
number
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.minLength
number
count (integer)		Optional
No @default declared; consult the signature and description.
outputSchema.minimum
number
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.multipleOf
number
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.oneOf
JSONSchema[]
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.pattern
string
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.properties
Record<string, JSONSchema>
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.required
string[]
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.title
string
unitless by name		Optional
No @default declared; consult the signature and description.
outputSchema.type
import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]
unitless by name		Optional
No @default declared; consult the signature and description.
run
(input: unknown) => ToolResult
unitless by name		Required / declared member
No @default declared; consult the signature and description.
run().return.structured
Record<string, unknown>		Machine-readable structured output (returned as MCP `structuredContent`).
unitless by name		Required / declared member
No @default declared; consult the signature and description.
run().return.summary
string		Human-readable one-line summary.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
run(input)
unknown
unitless by name		Required / declared member
No @default declared; consult the signature and description.
schema
Schema<unknown>
unitless by name		Required / declared member
No @default declared; consult the signature and description.
schema.describe
(description: string) => Schema<unknown>
unitless by name		Required / declared member
No @default declared; consult the signature and description.
schema.describe(description)
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
schema.isOptional
boolean
unitless by name		Required / declared member
No @default declared; consult the signature and description.
schema.kind
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
schema.optional
() => Schema<unknown>
unitless by name		Required / declared member
No @default declared; consult the signature and description.
schema.parse
(input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => unknown
unitless by name		Required / declared member
No @default declared; consult the signature and description.
schema.parse(input)
unknown
unitless by name		Required / declared member
No @default declared; consult the signature and description.
schema.parse(options)
import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined
unitless by name		Optional
No @default declared; consult the signature and description.
schema.parse(options).mode
import('@insiderfinance/totalfinance/core/schema').ValidationMode		Validation strictness (spec §6). Defaults to `strict`.
unitless by name		Optional
No @default declared; consult the signature and description.
schema.safeParse
(input: unknown, options?: import('@insiderfinance/totalfinance/core/schema').ParseOptions) => import('@insiderfinance/totalfinance/core/schema').SafeParseResult<unknown>
unitless by name		Required / declared member
No @default declared; consult the signature and description.
schema.safeParse().return.data
unknown
unitless by name		Required / declared member
No @default declared; consult the signature and description.
schema.safeParse().return.error
InputError
unitless by name		Required / declared member
No @default declared; consult the signature and description.
schema.safeParse().return.issues
import('@insiderfinance/totalfinance/core/schema').SchemaIssue[]
unitless by name		Required / declared member
No @default declared; consult the signature and description.
schema.safeParse().return.success
(false) | (true)
unitless by name		Required / declared member
No @default declared; consult the signature and description.
schema.safeParse(input)
unknown
unitless by name		Required / declared member
No @default declared; consult the signature and description.
schema.safeParse(options)
import('@insiderfinance/totalfinance/core/schema').ParseOptions | undefined
unitless by name		Optional
No @default declared; consult the signature and description.
schema.safeParse(options).mode
import('@insiderfinance/totalfinance/core/schema').ValidationMode		Validation strictness (spec §6). Defaults to `strict`.
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema
() => JSONSchema
unitless by name		Required / declared member
No @default declared; consult the signature and description.
schema.toJSONSchema().return.$id
string
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.$schema
string
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.additionalProperties
boolean | JSONSchema
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.additionalProperties.$id
string
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.additionalProperties.$schema
string
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.additionalProperties.additionalProperties
boolean | JSONSchema
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.additionalProperties.allOf
JSONSchema[]
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.additionalProperties.anyOf
JSONSchema[]
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.additionalProperties.const
unknown
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.additionalProperties.default
unknown
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.additionalProperties.description
string
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.additionalProperties.enum
unknown[]
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.additionalProperties.exclusiveMaximum
number
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.additionalProperties.exclusiveMinimum
number
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.additionalProperties.format
string
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.additionalProperties.items
JSONSchema
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.additionalProperties.maxItems
number
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.additionalProperties.maxLength
number
count (integer)		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.additionalProperties.maximum
number
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.additionalProperties.minItems
number
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.additionalProperties.minLength
number
count (integer)		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.additionalProperties.minimum
number
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.additionalProperties.multipleOf
number
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.additionalProperties.oneOf
JSONSchema[]
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.additionalProperties.pattern
string
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.additionalProperties.properties
Record<string, JSONSchema>
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.additionalProperties.required
string[]
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.additionalProperties.title
string
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.additionalProperties.type
import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.allOf
JSONSchema[]
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.anyOf
JSONSchema[]
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.const
unknown
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.default
unknown
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.description
string
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.enum
unknown[]
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.exclusiveMaximum
number
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.exclusiveMinimum
number
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.format
string
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.items
JSONSchema
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.maxItems
number
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.maxLength
number
count (integer)		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.maximum
number
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.minItems
number
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.minLength
number
count (integer)		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.minimum
number
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.multipleOf
number
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.oneOf
JSONSchema[]
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.pattern
string
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.properties
Record<string, JSONSchema>
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.required
string[]
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.title
string
unitless by name		Optional
No @default declared; consult the signature and description.
schema.toJSONSchema().return.type
import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]
unitless by name		Optional
No @default declared; consult the signature and description.
schema.~standard
import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Props<unknown, unknown>
unitless by name		Required / declared member
No @default declared; consult the signature and description.
schema.~standard.types
({ readonly input: unknown; readonly output: unknown; }) | undefined
unitless by name		Optional
No @default declared; consult the signature and description.
schema.~standard.types.input
unknown
unitless by name		Required / declared member
No @default declared; consult the signature and description.
schema.~standard.types.output
unknown
unitless by name		Required / declared member
No @default declared; consult the signature and description.
schema.~standard.validate
(value: unknown) => import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Result<unknown>
unitless by name		Required / declared member
No @default declared; consult the signature and description.
schema.~standard.validate().return.issues
(readonly import('@insiderfinance/totalfinance/core/schema').StandardSchemaV1Issue[]) | (undefined)
unitless by name		Optional
No @default declared; consult the signature and description.
schema.~standard.validate().return.value
unknown
unitless by name		Required / declared member
No @default declared; consult the signature and description.
schema.~standard.validate(value)
unknown
unitless by name		Required / declared member
No @default declared; consult the signature and description.
schema.~standard.vendor
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
schema.~standard.version
1
unitless by name		Required / declared member
No @default declared; consult the signature and description.
stochastic
boolean | ((args: Record<string, unknown>) => boolean)		Whether a call draws random samples, so the server's deterministic seed policy applies (inject the default seed when absent; echo it in `structured.assumptions.seed`). `true` = every call; a predicate = per-call (e.g. VaR is stochastic only for `method: 'monteCarlo'`). Default `false`.
unitless by name		Optional
No @default declared; consult the signature and description.
title
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
preview (pre-1.0)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

function

analysisTools

The analysis-role tools beyond the compute defaults, as MCP tools.

export declare function analysisTools(): TotalFinanceTool[];
Stability, warnings & conventions
preview (pre-1.0)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

function

artifactPack

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare function artifactPack(): ToolPack;
Fields, parameters & returned members (2)
Name / typeMeaning & unitOptional / default
return.name
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.tools
TotalFinanceTool[]
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
preview (pre-1.0)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

function

backtestPack

The opt-in backtest pack (payload/runtime heavy — deliberately not a default).

export declare function backtestPack(): ToolPack;
Fields, parameters & returned members (2)
Name / typeMeaning & unitOptional / default
return.name
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.tools
TotalFinanceTool[]
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
preview (pre-1.0)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

function

calendarPack

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare function calendarPack(): ToolPack;
Fields, parameters & returned members (2)
Name / typeMeaning & unitOptional / default
return.name
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.tools
TotalFinanceTool[]
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
preview (pre-1.0)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

function

createTotalFinanceMcpServer

Build (but do not connect) a TotalFinance MCP server.

export declare function createTotalFinanceMcpServer(options?: McpServerOptions): Server;
Fields, parameters & returned members (16)
Name / typeMeaning & unitOptional / default
(options)
McpServerOptions
unitless by name		Optional
No @default declared; consult the signature and description.
(options).artifacts
ArtifactStoreReader		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".
unitless by name		Optional
No @default declared; consult the signature and description.
(options).capabilities
readonly string[]		What every caller of this server holds (Stage 7B.2 Decision 9); default the runtime's defaults.
unitless by name		Optional
No @default declared; consult the signature and description.
(options).clock
() => string		The instant stamped on a stored result's handle when `artifacts` is writable — the edge's clock (default `new Date().toISOString()`).
unitless by name		Optional
No @default declared; consult the signature and description.
(options).deadlineMs
number		Soft wall-clock budget per tool call (ms). A call exceeding it returns an error.
milliseconds		Optional
No @default declared; consult the signature and description.
(options).defaultSeed
number		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.
unitless by name		Optional
No @default declared; consult the signature and description.
(options).jobs
JobRunner		Explicit local worker runner; requires its artifact reader. Adds typed job controls, never grants.
unitless by name		Optional
No @default declared; consult the signature and description.
(options).maxInputBytes
number		Reject any tool call whose serialized arguments exceed this many bytes (compute-budget guard, spec §18.5). Default 64 KB.
unitless by name		Optional
No @default declared; consult the signature and description.
(options).packs
(OperationPack | ToolPack)[]		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.
unitless by name		Optional
No @default declared; consult the signature and description.
(options).pageSize
number		Maximum entries per tools/resources list page: integer 1–100, default 100.
count (integer)		Optional
No @default declared; consult the signature and description.
(options).profile
'default' | 'valuation' | 'options' | 'portfolio' | 'research' | 'strategies' | 'backtesting' | 'scenarios' | 'full'		Task selection when neither tools nor packs is supplied. Explicit tools/packs remain exact.
unitless by name		Optional
No @default declared; consult the signature and description.
(options).readOnly
boolean		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.
unitless by name		Optional
No @default declared; consult the signature and description.
(options).stores
{ authorization?: AuthorizationStore; journal?: ExecutionJournalStore; }		The trade lifecycle's stores (Decision 10).
unitless by name		Optional
No @default declared; consult the signature and description.
(options).stores.authorization
AuthorizationStore
unitless by name		Optional
No @default declared; consult the signature and description.
(options).stores.journal
ExecutionJournalStore
unitless by name		Optional
No @default declared; consult the signature and description.
(options).tools
TotalFinanceTool[]		Override the default tool set with an explicit list (the low-level escape hatch).
unitless by name		Optional
No @default declared; consult the signature and description.
Stability, warnings & conventions
preview (pre-1.0)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

function

cryptoPack

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare function cryptoPack(): ToolPack;
Fields, parameters & returned members (2)
Name / typeMeaning & unitOptional / default
return.name
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.tools
TotalFinanceTool[]
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
preview (pre-1.0)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

function

defaultPacks

The ten domain packs that make up the default read-only server, in tool-list order.

export declare function defaultPacks(): ToolPack[];
Stability, warnings & conventions
preview (pre-1.0)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

function

defaultTools

The default read-only tool set — every domain pack flattened (dx §WS-5).

export declare function defaultTools(): TotalFinanceTool[];
Stability, warnings & conventions
preview (pre-1.0)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

function

defineTool

Define a caller's own tool (the escape hatch for a custom server); validated on every run.

export declare function defineTool<I>(definition: { name: string; title: string; description: string; schema: Schema<I>; outputSchema?: JSONSchema; mutates?: boolean; stochastic?: boolean | ((args: Record<string, unknown>) => boolean); run: (input: I) => ToolResult | OperationOutput<Record<string, unknown>>; }): TotalFinanceTool;
Fields, parameters & returned members (17)
Name / typeMeaning & unitOptional / default
(definition)
{ name: string; title: string; description: string; schema: Schema<I>; outputSchema?: JSONSchema; mutates?: boolean; stochastic?: boolean | ((args: Record<string, unknown>) => boolean); run: (input: I) => ToolResult | OperationOutput<Record<string, unknown>>; }
unitless by name		Required / declared member
No @default declared; consult the signature and description.
(definition).description
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
(definition).mutates
boolean
unitless by name		Optional
No @default declared; consult the signature and description.
(definition).name
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
(definition).outputSchema
JSONSchema
unitless by name		Optional
No @default declared; consult the signature and description.
(definition).run
(input: I) => ToolResult | OperationOutput<Record<string, unknown>>
unitless by name		Required / declared member
No @default declared; consult the signature and description.
(definition).schema
Schema<I>
unitless by name		Required / declared member
No @default declared; consult the signature and description.
(definition).stochastic
boolean | ((args: Record<string, unknown>) => boolean)
unitless by name		Optional
No @default declared; consult the signature and description.
(definition).title
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.description
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.mutates
boolean		Whether the tool mutates state (filtered out in read-only mode). Default `false`.
unitless by name		Optional
No @default declared; consult the signature and description.
return.name
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.outputSchema
JSONSchema		JSON Schema describing the structured output (the `structured` slot). On the wire every tool's `outputSchema` is the full `OperationResult` envelope wrapping this schema.
unitless by name		Optional
No @default declared; consult the signature and description.
return.run
(input: unknown) => ToolResult
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.schema
Schema<unknown>
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.stochastic
boolean | ((args: Record<string, unknown>) => boolean)		Whether a call draws random samples, so the server's deterministic seed policy applies (inject the default seed when absent; echo it in `structured.assumptions.seed`). `true` = every call; a predicate = per-call (e.g. VaR is stochastic only for `method: 'monteCarlo'`). Default `false`.
unitless by name		Optional
No @default declared; consult the signature and description.
return.title
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
preview (pre-1.0)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

function

fixedIncomePack

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare function fixedIncomePack(): ToolPack;
Fields, parameters & returned members (2)
Name / typeMeaning & unitOptional / default
return.name
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.tools
TotalFinanceTool[]
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
preview (pre-1.0)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

function

journeyPacks

The five journey packs as tool packs (the valuation pack joined in Stage 4.7): `createTotalFinanceMcpServer({ packs: [...defaultPacks(), ...journeyPacks()] })`.

export declare function journeyPacks(): ToolPack[];
Stability, warnings & conventions
preview (pre-1.0)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

function

optionsPack

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare function optionsPack(): ToolPack;
Fields, parameters & returned members (2)
Name / typeMeaning & unitOptional / default
return.name
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.tools
TotalFinanceTool[]
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
preview (pre-1.0)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

function

performancePack

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare function performancePack(): ToolPack;
Fields, parameters & returned members (2)
Name / typeMeaning & unitOptional / default
return.name
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.tools
TotalFinanceTool[]
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
preview (pre-1.0)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

function

portfolioPack

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare function portfolioPack(): ToolPack;
Fields, parameters & returned members (2)
Name / typeMeaning & unitOptional / default
return.name
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.tools
TotalFinanceTool[]
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
preview (pre-1.0)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

function

researchPack

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare function researchPack(): ToolPack;
Fields, parameters & returned members (2)
Name / typeMeaning & unitOptional / default
return.name
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.tools
TotalFinanceTool[]
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
preview (pre-1.0)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

function

riskPack

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare function riskPack(): ToolPack;
Fields, parameters & returned members (2)
Name / typeMeaning & unitOptional / default
return.name
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.tools
TotalFinanceTool[]
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
preview (pre-1.0)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

function

scenarioPack

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare function scenarioPack(): ToolPack;
Fields, parameters & returned members (2)
Name / typeMeaning & unitOptional / default
return.name
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.tools
TotalFinanceTool[]
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
preview (pre-1.0)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

function

strategyPack

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare function strategyPack(): ToolPack;
Fields, parameters & returned members (2)
Name / typeMeaning & unitOptional / default
return.name
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.tools
TotalFinanceTool[]
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
preview (pre-1.0)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

function

structurePack

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare function structurePack(): ToolPack;
Fields, parameters & returned members (2)
Name / typeMeaning & unitOptional / default
return.name
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.tools
TotalFinanceTool[]
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
preview (pre-1.0)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

function

technicalAnalysisPack

Public declaration. Read the signature and parameter/member contracts below; no additional behavior is inferred.

export declare function technicalAnalysisPack(): ToolPack;
Fields, parameters & returned members (2)
Name / typeMeaning & unitOptional / default
return.name
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.tools
TotalFinanceTool[]
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
preview (pre-1.0)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.

function

toolFromOperation

Render a registry operation as an MCP tool — the shipped tools are exactly these.

export declare function toolFromOperation(operation: TotalFinanceOperation): TotalFinanceTool;
Fields, parameters & returned members (77)
Name / typeMeaning & unitOptional / default
(operation)
TotalFinanceOperation<unknown, Record<string, unknown>>
unitless by name		Required / declared member
No @default declared; consult the signature and description.
(operation).authorization
import('@insiderfinance/totalfinance/workflows').OperationAuthorization
unitless by name		Required / declared member
No @default declared; consult the signature and description.
(operation).costClass
import('@insiderfinance/totalfinance/workflows').OperationCostClass
unitless by name		Required / declared member
No @default declared; consult the signature and description.
(operation).description
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
(operation).deterministic
boolean
unitless by name		Required / declared member
No @default declared; consult the signature and description.
(operation).handleFields
readonly string[]		Input paths that accept a resource handle in place of inline data.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
(operation).id
string		The wire identity every transport uses: `totalfinance.<domain>.<verb>`.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
(operation).idempotency
import('@insiderfinance/totalfinance/workflows').OperationIdempotency
unitless by name		Required / declared member
No @default declared; consult the signature and description.
(operation).inputSchema
Schema<unknown>
unitless by name		Required / declared member
No @default declared; consult the signature and description.
(operation).outputSchema
JSONSchema | null
unitless by name		Required / declared member
No @default declared; consult the signature and description.
(operation).outputSchema.$id
string
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.$schema
string
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.additionalProperties
boolean | JSONSchema
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.additionalProperties.$id
string
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.additionalProperties.$schema
string
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.additionalProperties.additionalProperties
boolean | JSONSchema
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.additionalProperties.allOf
JSONSchema[]
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.additionalProperties.anyOf
JSONSchema[]
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.additionalProperties.const
unknown
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.additionalProperties.default
unknown
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.additionalProperties.description
string
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.additionalProperties.enum
unknown[]
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.additionalProperties.exclusiveMaximum
number
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.additionalProperties.exclusiveMinimum
number
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.additionalProperties.format
string
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.additionalProperties.items
JSONSchema
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.additionalProperties.maxItems
number
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.additionalProperties.maxLength
number
count (integer)		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.additionalProperties.maximum
number
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.additionalProperties.minItems
number
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.additionalProperties.minLength
number
count (integer)		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.additionalProperties.minimum
number
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.additionalProperties.multipleOf
number
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.additionalProperties.oneOf
JSONSchema[]
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.additionalProperties.pattern
string
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.additionalProperties.properties
Record<string, JSONSchema>
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.additionalProperties.required
string[]
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.additionalProperties.title
string
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.additionalProperties.type
import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.allOf
JSONSchema[]
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.anyOf
JSONSchema[]
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.const
unknown
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.default
unknown
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.description
string
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.enum
unknown[]
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.exclusiveMaximum
number
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.exclusiveMinimum
number
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.format
string
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.items
JSONSchema
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.maxItems
number
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.maxLength
number
count (integer)		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.maximum
number
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.minItems
number
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.minLength
number
count (integer)		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.minimum
number
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.multipleOf
number
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.oneOf
JSONSchema[]
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.pattern
string
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.properties
Record<string, JSONSchema>
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.required
string[]
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.title
string
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).outputSchema.type
import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName | import('@insiderfinance/totalfinance/core/schema').JSONSchemaTypeName[]
unitless by name		Optional
No @default declared; consult the signature and description.
(operation).requiredCapabilities
readonly string[]
unitless by name		Required / declared member
No @default declared; consult the signature and description.
(operation).run
(input: unknown, context: import('@insiderfinance/totalfinance/workflows').OperationContext) => OperationOutput<Record<string, unknown>>		SYNCHRONOUS — compute never awaits; the runtime, the job runner, and the transports own asynchrony.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
(operation).sideEffect
import('@insiderfinance/totalfinance/workflows').OperationSideEffect
unitless by name		Required / declared member
No @default declared; consult the signature and description.
(operation).stochastic
boolean | ((input: unknown) => boolean)		A call that draws random samples — `true` for every call, or a per-call predicate over the PARSED input. (Declared through a method type so a specifically typed operation stays assignable to the registry's `TotalFinanceOperation<unknown>` — the predicate reads its own parsed input.)
unitless by name		Required / declared member
No @default declared; consult the signature and description.
(operation).supportsCancellation
boolean		True only when the runtime can actually stop the work (a terminated worker), never a post-hoc report.
unitless by name		Required / declared member
No @default declared; consult the signature and description.
(operation).title
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
(operation).version
string		An integer string; a breaking output change bumps it (pre-1.0: no aliases).
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.description
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.mutates
boolean		Whether the tool mutates state (filtered out in read-only mode). Default `false`.
unitless by name		Optional
No @default declared; consult the signature and description.
return.name
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.outputSchema
JSONSchema		JSON Schema describing the structured output (the `structured` slot). On the wire every tool's `outputSchema` is the full `OperationResult` envelope wrapping this schema.
unitless by name		Optional
No @default declared; consult the signature and description.
return.run
(input: unknown) => ToolResult
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.schema
Schema<unknown>
unitless by name		Required / declared member
No @default declared; consult the signature and description.
return.stochastic
boolean | ((args: Record<string, unknown>) => boolean)		Whether a call draws random samples, so the server's deterministic seed policy applies (inject the default seed when absent; echo it in `structured.assumptions.seed`). `true` = every call; a predicate = per-call (e.g. VaR is stochastic only for `method: 'monteCarlo'`). Default `false`.
unitless by name		Optional
No @default declared; consult the signature and description.
return.title
string
unitless by name		Required / declared member
No @default declared; consult the signature and description.
Stability, warnings & conventions
preview (pre-1.0)

Declared field units are shown above. “Unitless by name” means the name alone does not establish a unit, not that a financial quantity has none. Check source descriptions, conventions, and the returned diagnostics. Errors and warnings are part of the result contract.