IBM Embedded Business AI Framework




General tab


The description is a useful place to describe your agent skill as well as the sorts of questions that it supports. It is designed to serve as an initial reference when sharing and collaborating with others.

By clicking the edit button, you will be able to enter custom markdown(MD) in a code editor. For more details on what type of MD is support, check out the section Online Help below. Once you apply these changes, you will immediately see these changes reflected.

The preview of the description is displayed at the lab view. In addition, the complete description is shown once you click on an agent to see the details and to access further actions:

Typical information to be present in the description:



Support Information


Settings is a useful place to specify agent specific key-value parameters. These parameters will be accessible to the agent later in the action development pipeline via function input parameters.

const settingValue = params.settings[<key>]

Settings are part of the agent YAML file and can be exported.


Secrets should be used to store hidden parameter values. It may be used to store credential information, such as API keys. Secrets are part of the function input parameters.

const secretValue = params.secrets[<key>]

Only the secrets key is part of the YAML file and will be exported. The values must be added each time the agent is imported.


EBA provides developers with control over various stages of its execution pipeline. Endpoints represent different processes that developers can utilize to achieve different behaviors suitable to their particular application. We support the following endpoints:

Online Help

The online help is input for the skills tab (next to the content tab). All collaborating agents are contributing to the online help which will be displayed at the skills tab.

If you are looking for a full blown example check out the following code snippet which can be copied and pasted directly into the Online Help code editor.

The online help is using a YAML structured text in the following way:

- priority: 1
  title: Main Section Title
    - title: Section Title 1
      description: >
        Tnis line will be shown as preview message for this agent.

        Additional description to be displayed on the General Tab.
        - Example Question 1
    - title: Section Title 2
      description: >
        Another description
        - Example Question 2
   - Example Question 1
   - Example Question 2
   - Example Question 3 with a variable user input __!

Each entry will be transformed into a link. If a user clicks on this link the sample question is copied into the Ask Watson input text field to post an agent question.

If you have variable input, e.g. "Show me the details for order with id 123" you can create the following example questions: "Show me the details for order with id __"

The pattern ‘_’ creates a placeholder. If the user clicks on this sample question the text is copied over and the pattern ‘_’ is highlighted. The user just need to type the placeholder value (here: 123) and hit enter to ask the assistant the complete question.

The Example Question 3 uses exactly the described pattern. A working example can be pulled from the documentation agent.

Documentation Agent

In addition asking the assistant the question help me will display a list of available agent skills.

Question 'Help Me'

edit this article