tool

This topic provides information about the available fields for tool SDF custom objects, which is used to define custom tool scripts in the SuiteCloud Development Framework (SDF).

For information about developing custom tool scripts, see SuiteScript 2.1 Custom Tool Script Type.

For additional information about the custom tool script object definition file, see Custom Tool Scripts as XML Definitions.

Feature Dependencies

• SERVERSIDESCRIPTING

Attributes

Name	Type	Required / Optional	Description
scriptid	string	Required	The ID of the custom tool script. Ensure that: The value starts with the prefix customtool. It is in lowercase. It contains only alphanumeric characters and underscores. It is unique. It matches the name of the custom tool object XML file. This attribute value can be up to 28 characters long. The default value is ‘customtool’.

Fields

Name	Type	Required / Optional	Description
name	string	Required	Name of the custom tool script.
scriptfile	filereference	Required	Location of the custom tool script file. This field must reference a .js file.
rpcschema	filereference	Required	Location of the custom tool JSON schema file. This script must reference a .json file.
exposeto3rdpartyagents	boolean	Required	Set to T to make the custom tools available through Model Context Protocol (MCP) connection. The default value is F.

Structured Fields

Structured fields are elements that usually contain subfields or groups of fields. They are similar to regular fields but have their own embedded structure. The following structured fields are supported:

• permissions

General Notices