Skip to content

Slot: Tool Description (tool_description)

One-line tool description (from the tool's dht env var or equivalent).

Tier: optional

Why this slot matters

A one-line description lets a reader understand what the tool does without leaving the record or resolving the tool name against external documentation. Omitting it costs readability, not reproducibility.

In plain terms

A short plain-language note on the tool's job, for example "extracts daily temperature for a list of addresses". It saves the reader a lookup elsewhere.

URI: envar:slot/tool_description

Applicable Classes

Name Description Modifies Slot
ToolRun A single tool invocation that produced an output from one or more inputs: too... no

Properties

Type and Range

Property Value
Range String
Domain Of ToolRun

Cardinality and Requirements

Property Value

Examples

Value
DeGAUSS Daymet extraction container

See Also

Identifier and Mapping Information

Annotations

property value
tier optional
justification A one-line description lets a reader understand what the tool does without leaving the record or resolving the tool name against external documentation. Omitting it costs readability, not reproducibility.
explanation A short plain-language note on the tool's job, for example "extracts daily temperature for a list of addresses". It saves the reader a lookup elsewhere.

Schema Source

Mappings

Mapping Type Mapped Value
self envar:tool_description
native envar:tool_description

LinkML Source

name: tool_description
annotations:
  tier:
    tag: tier
    value: optional
  justification:
    tag: justification
    value: A one-line description lets a reader understand what the tool does without
      leaving the record or resolving the tool name against external documentation.
      Omitting it costs readability, not reproducibility.
  explanation:
    tag: explanation
    value: A short plain-language note on the tool's job, for example "extracts daily
      temperature for a list of addresses". It saves the reader a lookup elsewhere.
description: One-line tool description (from the tool's `dht` env var or equivalent).
title: Tool Description
examples:
- value: DeGAUSS Daymet extraction container
from_schema: https://w3id.org/linkml/microschemas/envar
see_also:
- https://degauss.org/
rank: 1000
domain_of:
- ToolRun
range: string