Tool.parameters

Note:

The content in this help topic pertains to SuiteScript 2.1.

Property Description	The parameters for the tool.
Type	llm.ToolParameter[]
Supported Script Types	Server scripts For more information, see SuiteScript 2.x Script Types.
Module	N/llm Module
Parent Object	llm.Tool
Sibling Object Members	Tool Object Members
Since	2025.2

Errors

Error Code	Thrown If
READ_ONLY	Setting the property is attempted.

Syntax

Important:

The following code sample shows the syntax for this member. It isn't a functional example. For a complete script example, see N/llm Module Script Samples.

            // Add additional code
...

const findUserIdTool = llm.createTool({
    name: "findUserId",
    description: "Looks up user ID based on user name",
    parameters: [
        llm.createToolParameter({
            name: "userName",
            description: "Name of the user",
            type: llm.ToolParameterType.STRING
        })
    ]
});

const toolParameters = findUserIdTool.parameters;

...
// Add additional code 

          

General Notices