Tcl

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.

Tcl

load ./chilkat.dll

set 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.
set sbJs [new_CkStringBuilder]

set success [CkStringBuilder_LoadFile $sbJs "qa_data/js_tools/toolset_3.js" "utf-8"]
if {$success == 0} then {
    puts [CkStringBuilder_lastErrorText $sbJs]
    delete_CkStringBuilder $sbJs
    exit
}

set ai [new_CkAi]

#  Register the tools that will be made available to the AI.
set evalOnly 0
set allowAllKeyword 1
CkAi_RegisterJsTools $ai $sbJs $evalOnly $allowAllKeyword

#  The provider can be "openai", "google", "claude", "grok", "mistral", "custom", etc.
CkAi_put_Provider $ai "openai"
#  Use your provider's API key.
CkAi_put_ApiKey $ai "MY_API_KEY"
#  Choose a model.
CkAi_put_Model $ai "gpt-5.6-luna"

#  Tool function calling must always occur within a conversation.
set conversation_name "convo_3"
set sysMessage "You are a helpful system admin"
set devMessage "Respond only with markdown."
CkAi_NewConvo $ai $conversation_name $sysMessage $devMessage

#  Provide inputs
CkAi_InputAddText $ai "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.
set success [CkAi_Ask $ai "text"]
if {$success == 0} then {
    puts [CkAi_lastErrorText $ai]
    delete_CkStringBuilder $sbJs
    delete_CkAi $ai
    exit
}

#  Get the AI response.
set sbResponse [new_CkStringBuilder]

CkAi_GetOutputTextSb $ai $sbResponse
puts [CkStringBuilder_getAsString $sbResponse]

delete_CkStringBuilder $sbJs
delete_CkAi $ai
delete_CkStringBuilder $sbResponse

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";