Describe utility
describe_utilityRetrieve full documentation for a single string utility, including parameters, defaults, and examples, to learn exact usage before running it.
Instructions
Full documentation for one utility: its parameters (kind, default, options/bounds, description), the value types it accepts/produces, tags, aliases, worked examples (input, inputEncoding, params and expected output — byte outputs there use the app's display format, while run_utility returns bytes as base64), and which runtime capabilities it needs. Call this before run_utility to learn the exact parameter names and defaults; skip it for a utility you have already described. id must be an exact, case-sensitive utility id: names and aliases are not resolved, so look those up with list_utilities first. An unknown id returns isError ("unknown utility: "). When unavailable is set, run_utility and run_pipeline refuse the utility.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Utility id, as returned by list_utilities (e.g. "base64_encode"). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| env | Yes | Runtime capabilities the utility needs (dom, wasm, eval, main). | |
| name | Yes | ||
| tags | Yes | ||
| params | Yes | Parameter name -> spec (kind, label, default, options/bounds, description…). | |
| accepts | Yes | Value type(s) the utility takes: string, bytes or json. | |
| aliases | Yes | ||
| category | Yes | ||
| examples | Yes | Worked examples: input, params and expected output. | |
| produces | Yes | Value type(s) the utility returns. | |
| description | Yes | ||
| unavailable | No | Why this server will not run the utility, when it will not. |