@insiderfinance/totalfinance-mcp

function

toolNameFor

The MCP tool name of an operation: the dotted operation id with every dot replaced by an underscore (`totalfinance.option.price` → `totalfinance_option_price`). MCP clients constrain tool names to `[A-Za-z0-9_-]`; the dotted id stays the operation's identity everywhere else — in `_meta['totalfinance/operation'].id`, `totalfinance://operations/<id>`, the HTTP paths and the CLI.

export declare function toolNameFor(operationId: string): string;

Fields, parameters & returned members (1)

Name / type	Meaning & unit	Optional / default
`(operationId)` `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

valuationPack

The company-valuation journey pack (Stage 4.7 slice 2): `totalfinance.valuation.company`.

export declare function valuationPack(): ToolPack;

Fields, parameters & returned members (2)

Name / type	Meaning & unit	Optional / 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

volatilityPack

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

export declare function volatilityPack(): ToolPack;

Fields, parameters & returned members (2)

Name / type	Meaning & unit	Optional / 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.