> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nika.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# description

> Contract, placement, related fields and source examples for this Nika YAML field.

[Language reference](https://docs.nika.sh/reference/language/overview.md) / `description`

## Meaning and placement

### → inputs · additionalProperties

Free-form prose about this input · what a caller is being asked for. Documentation only — the contract is `type` and `required`.

| Property | Declaration |
| - | - |
| Requirement | Optional in this object |
| Schema location | `/properties/inputs/additionalProperties/properties/description` |
| type | `"string"` |

**In the same object:** [default](https://docs.nika.sh/reference/language/words/default.md) · [required](https://docs.nika.sh/reference/language/words/required.md) · [type](https://docs.nika.sh/reference/language/words/type.md)

[Schema source (use the pointer above)](https://github.com/supernovae-st/nika-spec/blob/4e259e5b8012fcdf92f094142a52dfef24099b85/schemas/workflow.schema.json)

### → const · additionalProperties · then

Free-form prose about this constant · why the value is what it is. Documentation only — the contract is `type` and `value`.

| Property | Declaration |
| - | - |
| Requirement | Optional in this object |
| Schema location | `/properties/const/additionalProperties/then/properties/description` |
| type | `"string"` |

**In the same object:** [type](https://docs.nika.sh/reference/language/words/type.md) · [value](https://docs.nika.sh/reference/language/words/value.md)

[Schema source (use the pointer above)](https://github.com/supernovae-st/nika-spec/blob/4e259e5b8012fcdf92f094142a52dfef24099b85/schemas/workflow.schema.json)

### → outputs · additionalProperties · anyOf · 1

Free-form prose about this output · what a caller receives. Documentation only — the contract is `value` and `type`.

| Property | Declaration |
| - | - |
| Requirement | Optional in this object |
| Schema location | `/properties/outputs/additionalProperties/anyOf/1/properties/description` |
| type | `"string"` |

**In the same object:** [type](https://docs.nika.sh/reference/language/words/type.md) · [value](https://docs.nika.sh/reference/language/words/value.md)

[Schema source (use the pointer above)](https://github.com/supernovae-st/nika-spec/blob/4e259e5b8012fcdf92f094142a52dfef24099b85/schemas/workflow.schema.json)

## In a source template

Excerpt from `templates/agent-loop.nika`, source lines 40–49. This is a fragment, not a runnable workflow.

```yaml illustration theme={"system"}
    # RUNS the moment it is scaffolded. Replace the default with your job;
    # `--var goal=…` overrides it at any time.
    default: "<SLOT: what the agent must accomplish>"
    description: "What the agent must accomplish"   # SLOT

permits:                            # the blast radius · default-deny once present
  # Exactly what the body invokes: `nika:assert` (the confirm task) plus the
  # two the agent may call. No `fs:` — see the note on `tools:` below.
  tools: ["nika:assert", "nika:done", "nika:jq"]

```

### Templates containing this field

| Template | Source |
| - | - |
| `templates/agent-loop.nika` | [Line 43](https://github.com/supernovae-st/nika-spec/blob/4e259e5b8012fcdf92f094142a52dfef24099b85/templates/agent-loop.nika#L43) |
| `templates/docker-report.nika` | [Line 104](https://github.com/supernovae-st/nika-spec/blob/4e259e5b8012fcdf92f094142a52dfef24099b85/templates/docker-report.nika#L104) |
| `templates/etl-state.nika` | [Line 149](https://github.com/supernovae-st/nika-spec/blob/4e259e5b8012fcdf92f094142a52dfef24099b85/templates/etl-state.nika#L149) |

These are literal key occurrences in the source files, not an execution or conformance claim. [How to instantiate a template](https://docs.nika.sh/guides/templates.md).

## Contract and implementation

This page projects the named specification revision. Check [released engine status](https://docs.nika.sh/reference/status.md) and [the validation workflow](https://docs.nika.sh/guides/agent-authoring.md) before running a file. An optional field is not evidence that every engine supports every value.

Canonical identity: `language:word:description`. Spec revision: [`4e259e5b8012`](https://github.com/supernovae-st/nika-spec/tree/4e259e5b8012fcdf92f094142a52dfef24099b85).

[How documentation stays connected](https://docs.nika.sh/reference/knowledge-system.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.