FlowFuse / FlowFuse/nr-assistant

Normalize return payloads for automation requests

Open
#305 0 comments 0 reactions 0 assignees View on GitHub
task
Dominant language
JavaScript
Stars
5
Forks
5
Avg merge
2d 16h
Merged PRs (30d)
5

Description

### Description

Standardize the return payloads of all automation tool calls so they follow a single, predictable structure. Today, different tools return data in different shapes, which makes downstream consumption inconsistent and error-prone.

- Every tool call response must place its returned data under a top-level `result.data` attribute.
- The value of `result.data` can be of any type: integer, string, boolean, array, object, etc. (depending on what the tool returns).
- When a tool returns multiple values, `result.data` should be a keyed object where each key clearly describes the payload it holds (e.g. `result.data.user`, `result.data.order`) rather than positional or generic keys.

### Epic/Story

_No response_

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.