ns_searchFiles

Tool Name

ns_searchFiles

Tool Description

Searches file names across accessible File Cabinet folders using a case-insensitive match. File names match if they contain the search text. The tool doesn't search file contents.

The response includes matching files' details and complete paths in entries. Results are sorted by internal ID. A nextCursor value indicates that more matching rows remain to be checked.

Files without an accessible, valid path are omitted. A response can contain no entries even when hasMore is true. Changes to files between requests can affect the results.

If more than one file matches, use the File Cabinet Browser MCP App to select the intended file.

Annotation

Search File Cabinet Files

Properties

The following table lists the tool's properties.

Property

Type

Required or Optional

Description

search

string

Required

The text to match in file names. Leading and trailing spaces are removed. Specify 1 through 200 characters, without control characters.

pageSize

number

Optional

The maximum number of matching rows checked per request. Specify an integer from 1 through 100. Defaults to 50 if omitted or null. Fewer entries can be returned because files without accessible, valid paths are omitted.

cursor

string

Optional

The nextCursor value from this tool's previous response for the same search text after removing leading and trailing spaces. Use the value unchanged. Omit or use null for the first request.

Permissions

Your ability to search files depends on your NetSuite role's file and folder permissions.

Related Topics

General Notices