Skip to main content

​
Documentation

Read internal Herd documentation by document ID. Supports fetching multiple documents in a single call.

​
Returns

  • Document content — Full text of the requested documentation
  • Available IDs — If an unknown ID is provided, returns the list of available document IDs

​
Example Queries

Show me the HAL syntax documentation

Read the HAL examples and module docs

​
Parameters

ParameterRequiredDescription
documentIdYesA single document ID string, or an array of document IDs

​
Available Documents

Document IDContent
hal://spec/syntaxHAL grammar and special forms
hal://spec/modules/herdBlockchain functions (read, write, encode, swap, etc.)
hal://spec/examplesWorked HAL expression examples

​
Tips

Fetch all three HAL docs at once by passing an array: ["hal://spec/syntax", "hal://spec/modules/herd", "hal://spec/examples"]
Always read the HAL documentation before creating or editing HAL expressions — the syntax has non-obvious requirements.

​
Next Steps

HAL Reference

Full HAL language documentation

Evaluation

Simulate HAL expressions