import { DynamicStructuredTool, DynamicTool } from '@langchain/core/tools'; import type { JSONSchema7 } from 'json-schema'; import { JsTaskRunnerSandbox } from 'n8n-nodes-base/dist/nodes/Code/JsTaskRunnerSandbox'; import { PythonTaskRunnerSandbox } from 'n8n-nodes-base/dist/nodes/Code/PythonTaskRunnerSandbox'; import type { ExecutionError, IDataObject, IExecuteFunctions, INodeExecutionData, INodeType, INodeTypeDescription, ISupplyDataFunctions, SupplyData, } from 'n8n-workflow'; import { jsonParse, NodeConnectionTypes, nodeNameToToolName, NodeOperationError, } from 'n8n-workflow'; import { buildInputSchemaField, buildJsonSchemaExampleField, buildJsonSchemaExampleNotice, schemaTypeField, } from '@utils/descriptions'; import { convertJsonSchemaToZod, generateSchemaFromExample } from '@utils/schemaParsing'; import { getConnectionHintNoticeField } from '@n8n/ai-utilities'; import type { DynamicZodObject } from '../../../types/zod.types'; const jsonSchemaExampleField = buildJsonSchemaExampleField({ showExtraProps: { specifyInputSchema: [true] }, }); const jsonSchemaExampleNotice = buildJsonSchemaExampleNotice({ showExtraProps: { specifyInputSchema: [true], '@version': [{ _cnd: { gte: 1.3 } }], }, }); const jsonSchemaField = buildInputSchemaField({ showExtraProps: { specifyInputSchema: [true] } }); function getTool( ctx: ISupplyDataFunctions | IExecuteFunctions, itemIndex: number, log: boolean = true, ) { const node = ctx.getNode(); const workflowMode = ctx.getMode(); const { typeVersion } = node; const name = typeVersion <= 1.1 ? (ctx.getNodeParameter('name', itemIndex) as string) : nodeNameToToolName(node); const description = ctx.getNodeParameter('description', itemIndex) as string; const useSchema = ctx.getNodeParameter('specifyInputSchema', itemIndex) as boolean; const language = ctx.getNodeParameter('language', itemIndex) as string; let code = ''; if (language === 'javaScript') { code = ctx.getNodeParameter('jsCode', itemIndex) as string; } else { code = ctx.getNodeParameter('pythonCode', itemIndex) as string; } const runFunction = async (query: string | IDataObject): Promise => { if (language === 'javaScript') { const sandbox = new JsTaskRunnerSandbox(workflowMode, ctx, /*chunkSize=*/ undefined, { query, }); return await sandbox.runCodeForTool(code); } else { const sandbox = new PythonTaskRunnerSandbox( code, 'runOnceForAllItems', workflowMode, ctx as IExecuteFunctions, { query, }, ); return await sandbox.runCodeForTool(); } }; const toolHandler = async (query: string | IDataObject): Promise => { const { index } = log ? ctx.addInputData(NodeConnectionTypes.AiTool, [[{ json: { query } }]]) : { index: 0 }; let response: any = ''; let executionError: ExecutionError | undefined; try { response = await runFunction(query); } catch (error: unknown) { executionError = new NodeOperationError(ctx.getNode(), error as ExecutionError); response = `There was an error: "${executionError.message}"`; } if (typeof response === 'number') { response = (response as number).toString(); } if (typeof response !== 'string') { // TODO: Do some more testing. Issues here should actually fail the workflow executionError = new NodeOperationError(ctx.getNode(), 'Wrong output type returned', { description: `The response property should be a string, but it is an ${typeof response}`, }); response = `There was an error: "${executionError.message}"`; } if (executionError && log) { void ctx.addOutputData(NodeConnectionTypes.AiTool, index, executionError); } else if (log) { void ctx.addOutputData(NodeConnectionTypes.AiTool, index, [[{ json: { response } }]]); } return response; }; const commonToolOptions = { name, description, func: toolHandler, }; let tool: DynamicTool | DynamicStructuredTool | undefined = undefined; if (useSchema) { try { // We initialize these even though one of them will always be empty // it makes it easier to navigate the ternary operator const jsonExample = ctx.getNodeParameter('jsonSchemaExample', itemIndex, '') as string; const inputSchema = ctx.getNodeParameter('inputSchema', itemIndex, '') as string; const schemaType = ctx.getNodeParameter('schemaType', itemIndex) as 'fromJson' | 'manual'; const jsonSchema = schemaType === 'fromJson' ? generateSchemaFromExample(jsonExample, ctx.getNode().typeVersion >= 1.3) : jsonParse(inputSchema); const zodSchema = convertJsonSchemaToZod(jsonSchema); tool = new DynamicStructuredTool({ schema: zodSchema, ...commonToolOptions, }); } catch (error) { throw new NodeOperationError( ctx.getNode(), 'Error during parsing of JSON Schema. \n ' + error, ); } } else { tool = new DynamicTool(commonToolOptions); } return tool; } export class ToolCode implements INodeType { description: INodeTypeDescription = { displayName: 'Code Tool', name: 'toolCode', icon: 'fa:code', iconColor: 'black', group: ['transform'], version: [1, 1.1, 1.2, 1.3], description: 'Write a tool in JS or Python', defaults: { name: 'Code Tool', }, codex: { categories: ['AI'], subcategories: { AI: ['Tools'], Tools: ['Recommended Tools'], }, resources: { primaryDocumentation: [ { url: 'https://docs.n8n.io/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolcode/', }, ], }, }, inputs: [], outputs: [NodeConnectionTypes.AiTool], outputNames: ['Tool'], properties: [ getConnectionHintNoticeField([NodeConnectionTypes.AiAgent]), { displayName: 'See an example of a conversational agent with custom tool written in JavaScript here.', name: 'noticeTemplateExample', type: 'notice', default: '', }, { displayName: 'Name', name: 'name', type: 'string', default: '', placeholder: 'My_Tool', displayOptions: { show: { '@version': [1], }, }, }, { displayName: 'Name', name: 'name', type: 'string', default: '', placeholder: 'e.g. My_Tool', validateType: 'string-alphanumeric', description: 'The name of the function to be called, could contain letters, numbers, and underscores only', displayOptions: { show: { '@version': [1.1], }, }, }, { displayName: 'Description', name: 'description', type: 'string', default: '', placeholder: 'Call this tool to get a random color. The input should be a string with comma separted names of colors to exclude.', typeOptions: { rows: 3, }, }, { displayName: 'Language', name: 'language', type: 'options', noDataExpression: true, options: [ { name: 'JavaScript', value: 'javaScript', }, { name: 'Python (Beta)', value: 'python', }, ], default: 'javaScript', }, { displayName: 'JavaScript', name: 'jsCode', type: 'string', displayOptions: { show: { language: ['javaScript'], }, }, typeOptions: { editor: 'jsEditor', }, default: '// Example: convert the incoming query to uppercase and return it\nreturn query.toUpperCase()', // TODO: Add proper text here later hint: 'You can access the input the tool receives via the input property "query". The returned value should be a single string.', // eslint-disable-next-line n8n-nodes-base/node-param-description-missing-final-period description: 'E.g. Converts any text to uppercase', noDataExpression: true, }, { displayName: 'Python', name: 'pythonCode', type: 'string', displayOptions: { show: { language: ['python'], }, }, typeOptions: { editor: 'codeNodeEditor', // TODO: create a separate `pythonEditor` component editorLanguage: 'python', }, default: '# Example: convert the incoming query to uppercase and return it\nreturn _query.upper()', // TODO: Add proper text here later hint: 'You can access the input the tool receives via the input property "_query". The returned value should be a single string.', // eslint-disable-next-line n8n-nodes-base/node-param-description-missing-final-period description: 'E.g. Converts any text to uppercase', noDataExpression: true, }, { displayName: 'Specify Input Schema', name: 'specifyInputSchema', type: 'boolean', description: 'Whether to specify the schema for the function. This would require the LLM to provide the input in the correct format and would validate it against the schema.', noDataExpression: true, default: false, }, { ...schemaTypeField, displayOptions: { show: { specifyInputSchema: [true] } } }, jsonSchemaExampleField, jsonSchemaExampleNotice, jsonSchemaField, ], }; async supplyData(this: ISupplyDataFunctions, itemIndex: number): Promise { return { response: getTool(this, itemIndex), }; } async execute(this: IExecuteFunctions): Promise { const result: INodeExecutionData[] = []; const input = this.getInputData(); for (let i = 0; i < input.length; i++) { const item = input[i]; const tool = getTool(this, i, false); result.push({ json: { response: await tool.invoke(item.json), }, pairedItem: { item: i, }, }); } return [result]; } }