Guidelines

For best and consistent results keep these guidelines in mind when creating Tools and Agents -

• Use good names for tools and scenarios such that the name indicate their purpose. e.g. getOrderDetails is better then getO or doSomething. The Agent will use tool names to help improve its understanding of the tool during reasoning. So good names can help a lot.

• Provide good descriptions for scenarios, tools, parameters and return fields

  • Descriptions help the Agent understand what exactly the tool does and anything it should know about the tool. You can provide information such as special cases, or instructions that the Agent should keep in mind. Typically, the Agent does not need to know the implementation mechanics of the tool - i.e.g whether it is Database query or a REST API call.

    • e.g. getOrderDetails returns an Order object for the specific orderId. orderId is required. If not provided, it must be requested.

  • Description of the scenario helps map the user intent to the scenario. If the correct scenario is not being picked up then it could be because there is overlap between different scenarios so more than one scenario maps to the same user intent or that the agent is unable to map the user intent appropriately. Updating the scenario description to include the missing intent description and/or additional examples will help.

• Be consistent

  • Like us, Agents can get confused if terminology is inconsistent or different names are used to mean the same thing. e.g. if you are using model number in parts and then refer to it as part number elsewhere. The Agent might not be able to understand that they are the same.

• Mention special requirements

  • Specific formats such for dates or ids should be mentioned so the Agent can follow them

  • Abbreviations or commonly used alternative terms can also be mentioned

  • Special cases can be specified by describing the situation in plain language

  • Enums can be specified by providing a list of possible values

• Provide examples

  • If you have specific formats, or specific requirements, examples go a long way in helping the Agent understand what you might want. If an id has a specific format even though it is a string, you can provide the format and examples in the description.