Describe Tool

uproc.get_tool
ActionBusiness appsconnection required

Calls the uProc API with the connection's credentials.

Retrieve one uProc tool from the catalogue — what it does and which parameters it takes — so a run can be built without hardcoding them.

Connection

Required
Yes — the node will not save without one
Auth type
Username & password
Providers
uProc
Secret shape
{"email": "…", "api_token": "…"} — the account email and its API key
Resolved by
config.connection_id, else node.connection_id

Configuration

1 field, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.

FieldTypeRequiredDefaultConstraintsExample
tool
Name of the tool to describe, in dashed lower case as it appears in the uProc catalogue.
stringYes——get-email-lookup

Example configuration

Every value below is the contract’s own example or default — nothing invented.

{
  "tool": "get-email-lookup"
}

Output

One shape.

result

The provider's response object, as returned.

Extra keys beyond the ones listed can appear.

{}

See Describe Tool run in a workflow.

In a technical demo we add the uProc connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.