[UI] User is not instructed how to use the parameters in the Abilities section

[robert81]

Introduction

Most of the issues in the Abilities tab require parameter(s) to run:

The expected format of the parameters is JSON. Example; To specify a query in the Web Search ability, the user should use this format:

{"query": "WordPress login redirect loop fix", "num_results": 5}

Issue

We are expecting:

1. The user knows the JSON format
2. The user knows that the parameters should be specified in JSON format

What did you expect?

Solution options

There are two solutions possible. Using the "Web Search" ability to give examples. The most user friendly solution is solution 1.

Solution 1:

1. Give clear instructions of the format. Easiest format would be: parameter="value"

2. Add help text at the top of the Abilities page about this.

**How to specify parameters**

Use the following format for each parameter:

parameter-name="value"

To specify multiple parameters, enter one parameter per line and use a new line for each additional parameter"

3. If a user specifies something, but it is not the correct format, show an error "Parameters cannot be read. Please check they are specified correctly, and and try again"

Solution 2

If we want the user to specify the parameters in JOSN format, add the below text at the top of the abilities page:

**How to specify parameters**

The parameters should be specified in JSON format. Example:

{"parameter-1-name": "value-1", "parameter-2-name": "value-2"}