Skip to content

Class: ToolResult

Logical tool invocation result as seen by the consumer (after the MCP layer has unwrapped MCPToolResponse). Closes audit §3.1 row 20. Slot names match apps/web-shell/src/mocks/calcService.ts — includes resultLayer, resultLayers, parameters, datasets which are free-form per Article XV.2 (their inner shapes are tool-specific).

URI: debrief:class/ToolResult

 classDiagram
    class ToolResult
    click ToolResult href "../../classes/ToolResult/"
      ToolResult : datasets





        ToolResult --> "*" Any : datasets
        click Any href "../../classes/Any/"



      ToolResult : message

      ToolResult : parameters





        ToolResult --> "0..1" Any : parameters
        click Any href "../../classes/Any/"



      ToolResult : resultLayer





        ToolResult --> "0..1" Any : resultLayer
        click Any href "../../classes/Any/"



      ToolResult : resultLayers





        ToolResult --> "*" Any : resultLayers
        click Any href "../../classes/Any/"



      ToolResult : success


Slots

Name Cardinality and Range Description Inheritance
success 1
Boolean
Whether the tool succeeded direct
message 1
String
Status / explanation message direct
resultLayer 0..1
Any
Optional single result layer (e direct
resultLayers *
Any
Optional multiple result layers (e direct
parameters 0..1
Any
Optional record of operator-tunable parameters and their values (keyed by par... direct
datasets *
Any
Optional dataset results for the Results panel (range-bearing charts, etc) direct

Identifier and Mapping Information

Schema Source

  • from schema: https://debrief.info/schemas/debrief

Mappings

Mapping Type Mapped Value
self debrief:ToolResult
native debrief:ToolResult

LinkML Source

Direct

name: ToolResult
description: Logical tool invocation result as seen by the consumer (after the MCP
  layer has unwrapped MCPToolResponse). Closes audit §3.1 row 20. Slot names match
  `apps/web-shell/src/mocks/calcService.ts` — includes `resultLayer`, `resultLayers`,
  `parameters`, `datasets` which are free-form per Article XV.2 (their inner shapes
  are tool-specific).
from_schema: https://debrief.info/schemas/debrief
attributes:
  success:
    name: success
    description: Whether the tool succeeded.
    from_schema: https://debrief.info/schemas/mcp
    rank: 1000
    domain_of:
    - ToolResult
    - ToolResultForLog
    - ToolExecutionResultForReplay
    range: boolean
    required: true
  message:
    name: message
    description: Status / explanation message.
    from_schema: https://debrief.info/schemas/mcp
    rank: 1000
    domain_of:
    - ToolResult
    range: string
    required: true
  resultLayer:
    name: resultLayer
    description: Optional single result layer (e.g. bounding-box polygon).
    from_schema: https://debrief.info/schemas/mcp
    rank: 1000
    domain_of:
    - ToolResult
    range: Any
  resultLayers:
    name: resultLayers
    description: Optional multiple result layers (e.g. buffer-zone polygons).
    from_schema: https://debrief.info/schemas/mcp
    rank: 1000
    domain_of:
    - ToolResult
    range: Any
    multivalued: true
  parameters:
    name: parameters
    description: Optional record of operator-tunable parameters and their values (keyed
      by parameter name, values shaped like ToolParameterMeta). Free-form per Article
      XV.2 (a LinkML `inlined_as_dict` of ToolParameterMeta would express it, but
      consumers already build a plain `Record<string, ToolParameterMeta>` and narrow
      on the way out — keeping it free-form preserves the live wire shape).
    from_schema: https://debrief.info/schemas/mcp
    domain_of:
    - WasGeneratedBy
    - ToolResult
    range: Any
  datasets:
    name: datasets
    description: 'Optional dataset results for the Results panel (range-bearing charts,
      etc). Each entry shaped like `{ filename: string, envelope: Record<string, unknown>
      }`.'
    from_schema: https://debrief.info/schemas/mcp
    rank: 1000
    domain_of:
    - ToolResult
    range: Any
    multivalued: true

Induced

name: ToolResult
description: Logical tool invocation result as seen by the consumer (after the MCP
  layer has unwrapped MCPToolResponse). Closes audit §3.1 row 20. Slot names match
  `apps/web-shell/src/mocks/calcService.ts` — includes `resultLayer`, `resultLayers`,
  `parameters`, `datasets` which are free-form per Article XV.2 (their inner shapes
  are tool-specific).
from_schema: https://debrief.info/schemas/debrief
attributes:
  success:
    name: success
    description: Whether the tool succeeded.
    from_schema: https://debrief.info/schemas/mcp
    rank: 1000
    alias: success
    owner: ToolResult
    domain_of:
    - ToolResult
    - ToolResultForLog
    - ToolExecutionResultForReplay
    range: boolean
    required: true
  message:
    name: message
    description: Status / explanation message.
    from_schema: https://debrief.info/schemas/mcp
    rank: 1000
    alias: message
    owner: ToolResult
    domain_of:
    - ToolResult
    range: string
    required: true
  resultLayer:
    name: resultLayer
    description: Optional single result layer (e.g. bounding-box polygon).
    from_schema: https://debrief.info/schemas/mcp
    rank: 1000
    alias: resultLayer
    owner: ToolResult
    domain_of:
    - ToolResult
    range: Any
  resultLayers:
    name: resultLayers
    description: Optional multiple result layers (e.g. buffer-zone polygons).
    from_schema: https://debrief.info/schemas/mcp
    rank: 1000
    alias: resultLayers
    owner: ToolResult
    domain_of:
    - ToolResult
    range: Any
    multivalued: true
  parameters:
    name: parameters
    description: Optional record of operator-tunable parameters and their values (keyed
      by parameter name, values shaped like ToolParameterMeta). Free-form per Article
      XV.2 (a LinkML `inlined_as_dict` of ToolParameterMeta would express it, but
      consumers already build a plain `Record<string, ToolParameterMeta>` and narrow
      on the way out — keeping it free-form preserves the live wire shape).
    from_schema: https://debrief.info/schemas/mcp
    alias: parameters
    owner: ToolResult
    domain_of:
    - WasGeneratedBy
    - ToolResult
    range: Any
  datasets:
    name: datasets
    description: 'Optional dataset results for the Results panel (range-bearing charts,
      etc). Each entry shaped like `{ filename: string, envelope: Record<string, unknown>
      }`.'
    from_schema: https://debrief.info/schemas/mcp
    rank: 1000
    alias: datasets
    owner: ToolResult
    domain_of:
    - ToolResult
    range: Any
    multivalued: true