Included Tools

The MCP Sample Tools SuiteApp is a set of predefined tools that demonstrate the types of operations you can perform through conversational AI. These tools are practical examples of what you can build with SuiteScript in the SuiteCloud environment.

Each tool uses the same framework available to SuiteCloud developers, so you can add your own custom tools. For more information about developing and deploying custom tools, see Custom Tool Script Requirements.

Note:

Parameters provided to a tool call are verified. Required parameters have to be present in the request.

List of Predefined Tools

Name	Description	Annotation	Properties	Required parameters
updateCustomer	Update the customer information in NetSuite. The fields that you can change are: firstname lastname isperson phone company name credit limit email subsidiary	Update Customer Information	customerId firstname lastname email phone companyname creditlimit subsidiary isperson - States if this customer is a person ('T') or a company ('F')	customerId
searchCustomer	Search for customers in NetSuite based on a partial name match. With an empty string, it retrieves all customers.	Search for Customers	query, type string	"query"
Run Custom SuiteQL	Runs a custom SuiteQL query in NetSuite. Useful for gathering information of all types.	Run Custom SuiteQL	sqlQuery description	sqlQuery
getSalesOrderWithFilters	Search and retrieve sales orders with optional filtering by customer, date range, and status. Remember for dates, always use MM/DD/YYYY format.	Get Sales Order with Filters	customerId dateFrom dateTo	-
getSalesOrder	Retrieve detailed information about a specific sales order, including header fields and line items. Returns: internalid transaction id customer id customer name date status po number memo sales rep id sales rep name total items array of items with the following fields: line, item id, item name, quantity, amount and description.	Get Sales Order	orderId	orderId
getItemDetails	Get detailed information about a specific item, including inventory details by location. The item details are: internalid itemid displayname displayname description type basePrice cost quantity available quantity on hand reorder point preferred location units type stock unit purchase unit sale unit weight weight unit datecreated isinactive	Get Item Details	itemId	itemId
getFinancialPerformance	Generate a simple financial performance summary of your NetSuite Account. Always use MM/DD/YYYY format for dates.	Get Financial Performance	dateFrom dateTo	-
getCustomerTransactions	Get transaction history for a customer. Always use MM/DD/YYYY format for dates. Returns a list of transaction with the following fields: id date document number type customer id amount status memo reference	Get Customer Transactions	customerId dateFrom dateTo	customerId
getCustomerDetails	Get detailed information about a specific customer. Returns: customer id name company name email phone credit limit terms shipAddress Id billingAddress Id category dateCreated subsidiary id currency id sales rep id price level contacts ids	Get Customer Details	customerId	customerId
getCustomerBalance	Get customer balance information.	Get Customer Balance	customerId	customerId
generateSalesReport	Generates a Sales Report of your NetSuite Account. Always use MM/DD/YYYY format for dates.	Generate Sales Report	dateFrom dateTo grouping	dateFrom dateTo
createCustomer	Create a customer in NetSuite. Use 'T' or 'F' in isperson to state if is a person or company. Use 'T' in isperson field to state this is a person or 'F' if it a company. In case it's a company, the companyname is required. In case it's a person, firstname and lastname are required.	Create Customer	firstname lastname email phone companyname creditlimit subsidiary isperson	firstname lastname subsidiary isperson
checkInventoryLevels	Check inventory levels, optionally filtered by location ID.	Check Inventory Levels	locationId	-

How To Invoke a Tool

You can use natural language in your client to invoke a tool. Use the tool description as a guide for how to write your message—for example: Create a customer for Name Surname in NetSuite.

The client then shows a pop-up asking for permission to use an external integration tool.

Permissions for Predefined Tools

To use most tools, you’ll need at least view permissions, but creating or updating customers needs edit permissions. The SuiteQL tool is an exception—there aren’t any strict permission requirements to access it. However, what you can see or query with SuiteQL still depends on your current permissions in the system.

Related Topics

• Get Started with the NetSuite AI Connector Service
• MCP Sample Tools Overview
• Key Features
• Enabling Required Features for MCP Sample Tools
• Installing MCP Sample Tools
• SuiteScript 2.1 Custom Tool Script Type
• Custom Tool Script Requirements

General Notices