SQL Server

Automatic JavaScript AI Tool Returning an Array

See more AI Examples

Demonstrates an automatic JavaScript tool function that returns an array. Automatic JavaScript tool calls are characterized by:

• Tool function implementations are in JavaScript.
• The JavaScript also provides a tool registry and permissions.
• The JavaScript runs embedded within your application using Chilkat.Js.
• Tool calls are handled entirely within Chilkat. Your application does not need to manually check for function calls in the AI response. Internal to the Ask function, Chilkat will handle function calls by calling your registered JavaScript tools and will send results back to the AI model until the final response is received.

SQL Server

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @sTmp0 nvarchar(4000)
    DECLARE @success int
    SELECT @success = 0

    --  ----------------------------------------------------------------------------------
    --  The Javascript file loaded here is shown at the bottom of this page.
    --  -----------------------------------------------------------------------------------

    --  In this example, we'll load the Javascript tool functions and registry from a file.
    --  It doesn't need to come from a file.  It could just as easily be loaded from a string.
    DECLARE @sbJs int
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbJs OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    EXEC sp_OAMethod @sbJs, 'LoadFile', @success OUT, 'qa_data/js_tools/toolset_3.js', 'utf-8'
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @sbJs, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @sbJs
        RETURN
      END

    DECLARE @ai int
    EXEC @hr = sp_OACreate 'Chilkat.Ai', @ai OUT

    --  Register the tools that will be made available to the AI.
    DECLARE @evalOnly int
    SELECT @evalOnly = 0
    DECLARE @allowAllKeyword int
    SELECT @allowAllKeyword = 1
    EXEC sp_OAMethod @ai, 'RegisterJsTools', @success OUT, @sbJs, @evalOnly, @allowAllKeyword

    --  The provider can be "openai", "google", "claude", "grok", "mistral", "custom", etc.
    EXEC sp_OASetProperty @ai, 'Provider', 'openai'
    --  Use your provider's API key.
    EXEC sp_OASetProperty @ai, 'ApiKey', 'MY_API_KEY'
    --  Choose a model.
    EXEC sp_OASetProperty @ai, 'Model', 'gpt-5.6-luna'

    --  Tool function calling must always occur within a conversation.
    DECLARE @conversation_name nvarchar(4000)
    SELECT @conversation_name = 'convo_3'
    DECLARE @sysMessage nvarchar(4000)
    SELECT @sysMessage = 'You are a helpful system admin'
    DECLARE @devMessage nvarchar(4000)
    SELECT @devMessage = 'Respond only with markdown.'
    EXEC sp_OAMethod @ai, 'NewConvo', @success OUT, @conversation_name, @sysMessage, @devMessage

    --  Provide inputs
    EXEC sp_OAMethod @ai, 'InputAddText', @success OUT, 'List the files in the directory c:/temp/abc'

    --  Send inputs, tool functions, etc. and ask for a "text" response.
    --  If the AI responds with tool calls, Chilkat automatically handles them by calling your JavaScript
    --  tool functions as directed by the AI, and sending results back to the AI until the final
    --  response is received.
    EXEC sp_OAMethod @ai, 'Ask', @success OUT, 'text'
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @ai, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @sbJs
        EXEC @hr = sp_OADestroy @ai
        RETURN
      END

    --  Get the AI response.
    DECLARE @sbResponse int
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponse OUT

    EXEC sp_OAMethod @ai, 'GetOutputTextSb', @success OUT, @sbResponse
    EXEC sp_OAMethod @sbResponse, 'GetAsString', @sTmp0 OUT
    PRINT @sTmp0

    EXEC @hr = sp_OADestroy @sbJs
    EXEC @hr = sp_OADestroy @ai
    EXEC @hr = sp_OADestroy @sbResponse


END
GO

JavaScript

// The namespace for the AI tool functions in this JavaScript source file.

Example = {};

// Tool functions must have only one argument, which should be an object.

// The function name used here must match the "name" in the toolRegistry below.

// By grouping list_files, toolRegistry, and toolPermissions under the Example object, 
// you are "namespacing" them. This tells anyone reading the code (and the JavaScript engine itself) 
// that these tools belong together and prevents them from clashing with another function that might 
// also be named list_files. 

Example.list_files = function(arg) {
  return [
    "report.pdf",
    "notes.txt",
    "image.png"
  ];
}

// The inputSchema.type must ALWAYS be "object".
Example.toolRegistry = [
  {
    name: "list_files",
    description: "List files in a directory",
    parameters: {
      properties: {
        path: { type: "string", description: "Directory path" },
      }
    }
  }
];


Example.toolPermissions = [
	  {
	    name: "all",
	    perm: "sandbox",
	  }
	  		
	];
	
	
// Return the name of this toolset
// This tells Chilkat the namespace of this toolset.
"Example";