Skills as XML Definitions

Use SuiteCloud Development Framework (SDF) to define and deploy a custom skill by adding an agentskill SDF custom object to a SuiteCloud project. The object identifies the skill and points to a File Cabinet folder that contains a SKILL.md file.

Custom Skill Definition

An SDF custom skill has two related components:

• An agentskill XML definition

• A skill content folder that contains SKILL.md

The skillfolder element in the XML definition must refer to the skill content folder. The folder and its files must exist when you validate and deploy the SuiteCloud project.

The following table lists the XML items that define the custom skill.

XML Item	Description
scriptid attribute	Identifies the agentskill SDF custom object.
<name>	Specifies the skill name. It must match the name value in the SKILL.md front matter exactly, including capitalization.
<description>	Specifies the skill description. It must match the description value in the SKILL.md front matter exactly, including capitalization.
<skillfolder>	Specifies the File Cabinet folder that contains SKILL.md.
<isinactive>	Indicates whether the skill is inactive. Use F for an active skill.
<ispublic>	Indicates whether the skill is public and available for other users to invoke. It can be set to T only by users with the Administrator role.

Skill Content in the Project

The location of the skill content folder depends on the SuiteCloud project type, as indicated in the following table.

Project Type	Skill Content Location	skillfolder Reference
SuiteApp project	The SuiteApp's directory	[/SuiteApps/<application_id>/<skill_folder>/]
account customization project (ACP)	The Skills directory at the File Cabinet root	[/Skills/<skill_folder>/]

The skill content folder must include a file named SKILL.md. The file must contain a Markdown instruction body for the skill that's not empty.

Skill Definition Validation

The skill is validated for the following during SuiteCloud project deployment:

• The skillfolder reference identifies an existing folder in the project.

• The folder contains SKILL.md.

• The name and description values in the XML definition match the corresponding SKILL.md front-matter values exactly.

• The SKILL.md file contains the instructions for the skill.

Skill XML Example

The following example defines an active custom skill in a SuiteApp project:

            <agentskill scriptid="customskill_simple_test_skill">
    <name>simple-test-skill</name>
    <description>Tiny deterministic test skill for confirming skill discovery and invocation.</description>
    <skillfolder>[/SuiteApps/com.netsuite.sdfskills/simple-test-skill/]</skillfolder>
    <isinactive>F</isinactive>
    <ispublic>F</ispublic>
</agentskill> 

          

General Notices