Tool Object Members Reference for SuiteScript 2.1

The Tool Object in SuiteScript 2.1 allows developers to define tools with specific properties that enhance their scripting capabilities. Understanding its members is crucial for constructing robust server scripts.

What Are Tool Object Members?

Tool Object Members are properties that describe various aspects of a tool in SuiteScript 2.1. The key members include:

Property Descriptions

• Tool.description: This property returns the description of the tool in string format, useful for documentation and clarity within your scripts.
• Tool.name: The name of the tool, also returned as a string, which serves to identify the tool when referenced in code.
• Tool.parameters: Returns an array of llm.ToolParameter objects, each representing a parameter that the tool accepts, allowing for customizable functionality.

Error Handling

When using Tool properties, developers should be aware of error codes such as READ_ONLY, which indicates that an attempt to set a property has been made, which is not permitted.

Example Syntax

Here's a brief example that illustrates the creation of a tool in SuiteScript 2.1:

1const findUserIdTool = llm.createTool({
2    name: "findUserId",
3    description: "Looks up user ID based on user name",
4    parameters: [
5        llm.createToolParameter({
6            name: "userName",
7            description: "Name of the user",
8            type: llm.ToolParameterType.STRING
9        })
10    ]
11});
12 
13const toolDescription = findUserIdTool.description;

In this code, a tool named findUserId is defined with a specific description and parameters, demonstrating how flexible and powerful the Tool Object can be in your server-side scripts.

Who This Affects

• Developers: Those working with SuiteScript 2.1 and needing to create or manipulate tools.
• Administrators: Individuals responsible for managing scripts and tools within NetSuite.

Key Takeaways

• Tool Object Members are key properties for server scripts in SuiteScript 2.1.
• Understanding each member facilitates effective tool creation.
• Error codes like READ_ONLY highlight important considerations during property assignments.