mirror of
https://github.com/Abdulazizzn/n8n-enterprise-unlocked.git
synced 2025-12-17 10:02:05 +00:00
feat: HTTP request tool (#9228)
This commit is contained in:
Michael Kret
@@ -0,0 +1,405 @@
|
||||
/* eslint-disable n8n-nodes-base/node-dirname-against-convention */
|
||||
import type {
|
||||
IExecuteFunctions,
|
||||
INodeType,
|
||||
INodeTypeDescription,
|
||||
SupplyData,
|
||||
IHttpRequestMethods,
|
||||
IHttpRequestOptions,
|
||||
} from 'n8n-workflow';
|
||||
import { NodeConnectionType, NodeOperationError, tryToParseAlphanumericString } from 'n8n-workflow';
|
||||
|
||||
import { getConnectionHintNoticeField } from '../../../utils/sharedFields';
|
||||
|
||||
import {
|
||||
configureHttpRequestFunction,
|
||||
configureResponseOptimizer,
|
||||
extractParametersFromText,
|
||||
prepareToolDescription,
|
||||
configureToolFunction,
|
||||
updateParametersAndOptions,
|
||||
} from './utils';
|
||||
|
||||
import {
|
||||
authenticationProperties,
|
||||
jsonInput,
|
||||
optimizeResponseProperties,
|
||||
parametersCollection,
|
||||
placeholderDefinitionsCollection,
|
||||
specifyBySelector,
|
||||
} from './descriptions';
|
||||
|
||||
import type { PlaceholderDefinition, ToolParameter } from './interfaces';
|
||||
|
||||
import { DynamicTool } from '@langchain/core/tools';
|
||||
|
||||
export class ToolHttpRequest implements INodeType {
|
||||
description: INodeTypeDescription = {
|
||||
displayName: 'HTTP Request Tool',
|
||||
name: 'toolHttpRequest',
|
||||
icon: { light: 'file:httprequest.svg', dark: 'file:httprequest.dark.svg' },
|
||||
group: ['output'],
|
||||
version: 1,
|
||||
description: 'Makes an HTTP request and returns the response data',
|
||||
subtitle: '={{ $parameter.toolDescription }}',
|
||||
defaults: {
|
||||
name: 'HTTP Request',
|
||||
},
|
||||
credentials: [],
|
||||
codex: {
|
||||
categories: ['AI'],
|
||||
subcategories: {
|
||||
AI: ['Tools'],
|
||||
},
|
||||
resources: {
|
||||
primaryDocumentation: [
|
||||
{
|
||||
url: 'https://docs.n8n.io/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolhttprequest/',
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
// eslint-disable-next-line n8n-nodes-base/node-class-description-inputs-wrong-regular-node
|
||||
inputs: [],
|
||||
// eslint-disable-next-line n8n-nodes-base/node-class-description-outputs-wrong
|
||||
outputs: [NodeConnectionType.AiTool],
|
||||
outputNames: ['Tool'],
|
||||
properties: [
|
||||
getConnectionHintNoticeField([NodeConnectionType.AiAgent]),
|
||||
{
|
||||
displayName: 'Description',
|
||||
name: 'toolDescription',
|
||||
type: 'string',
|
||||
description:
|
||||
'Explain to LLM what this tool does, better description would allow LLM to produce expected result',
|
||||
placeholder: 'e.g. Get the current weather in the requested city',
|
||||
default: '',
|
||||
typeOptions: {
|
||||
rows: 3,
|
||||
},
|
||||
},
|
||||
{
|
||||
displayName: 'Method',
|
||||
name: 'method',
|
||||
type: 'options',
|
||||
options: [
|
||||
{
|
||||
name: 'DELETE',
|
||||
value: 'DELETE',
|
||||
},
|
||||
{
|
||||
name: 'GET',
|
||||
value: 'GET',
|
||||
},
|
||||
{
|
||||
name: 'PATCH',
|
||||
value: 'PATCH',
|
||||
},
|
||||
{
|
||||
name: 'POST',
|
||||
value: 'POST',
|
||||
},
|
||||
{
|
||||
name: 'PUT',
|
||||
value: 'PUT',
|
||||
},
|
||||
],
|
||||
default: 'GET',
|
||||
},
|
||||
{
|
||||
displayName:
|
||||
'Tip: You can use a {placeholder} for any part of the request to be filled by the model. Provide more context about them in the placeholders section',
|
||||
name: 'placeholderNotice',
|
||||
type: 'notice',
|
||||
default: '',
|
||||
},
|
||||
{
|
||||
displayName: 'URL',
|
||||
name: 'url',
|
||||
type: 'string',
|
||||
default: '',
|
||||
required: true,
|
||||
placeholder: 'e.g. http://www.example.com/{path}',
|
||||
},
|
||||
...authenticationProperties,
|
||||
//----------------------------------------------------------------
|
||||
{
|
||||
displayName: 'Send Query Parameters',
|
||||
name: 'sendQuery',
|
||||
type: 'boolean',
|
||||
default: false,
|
||||
noDataExpression: true,
|
||||
description: 'Whether the request has query params or not',
|
||||
},
|
||||
{
|
||||
...specifyBySelector,
|
||||
displayName: 'Specify Query Parameters',
|
||||
name: 'specifyQuery',
|
||||
displayOptions: {
|
||||
show: {
|
||||
sendQuery: [true],
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
...parametersCollection,
|
||||
displayName: 'Query Parameters',
|
||||
name: 'parametersQuery',
|
||||
displayOptions: {
|
||||
show: {
|
||||
sendQuery: [true],
|
||||
specifyQuery: ['keypair'],
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
...jsonInput,
|
||||
name: 'jsonQuery',
|
||||
displayOptions: {
|
||||
show: {
|
||||
sendQuery: [true],
|
||||
specifyQuery: ['json'],
|
||||
},
|
||||
},
|
||||
},
|
||||
//----------------------------------------------------------------
|
||||
{
|
||||
displayName: 'Send Headers',
|
||||
name: 'sendHeaders',
|
||||
type: 'boolean',
|
||||
default: false,
|
||||
noDataExpression: true,
|
||||
description: 'Whether the request has headers or not',
|
||||
},
|
||||
{
|
||||
...specifyBySelector,
|
||||
displayName: 'Specify Headers',
|
||||
name: 'specifyHeaders',
|
||||
displayOptions: {
|
||||
show: {
|
||||
sendHeaders: [true],
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
...parametersCollection,
|
||||
displayName: 'Header Parameters',
|
||||
name: 'parametersHeaders',
|
||||
displayOptions: {
|
||||
show: {
|
||||
sendHeaders: [true],
|
||||
specifyHeaders: ['keypair'],
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
...jsonInput,
|
||||
name: 'jsonHeaders',
|
||||
displayOptions: {
|
||||
show: {
|
||||
sendHeaders: [true],
|
||||
specifyHeaders: ['json'],
|
||||
},
|
||||
},
|
||||
},
|
||||
//----------------------------------------------------------------
|
||||
{
|
||||
displayName: 'Send Body',
|
||||
name: 'sendBody',
|
||||
type: 'boolean',
|
||||
default: false,
|
||||
noDataExpression: true,
|
||||
description: 'Whether the request has body or not',
|
||||
},
|
||||
{
|
||||
...specifyBySelector,
|
||||
displayName: 'Specify Body',
|
||||
name: 'specifyBody',
|
||||
displayOptions: {
|
||||
show: {
|
||||
sendBody: [true],
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
...parametersCollection,
|
||||
displayName: 'Body Parameters',
|
||||
name: 'parametersBody',
|
||||
displayOptions: {
|
||||
show: {
|
||||
sendBody: [true],
|
||||
specifyBody: ['keypair'],
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
...jsonInput,
|
||||
name: 'jsonBody',
|
||||
displayOptions: {
|
||||
show: {
|
||||
sendBody: [true],
|
||||
specifyBody: ['json'],
|
||||
},
|
||||
},
|
||||
},
|
||||
//----------------------------------------------------------------
|
||||
placeholderDefinitionsCollection,
|
||||
...optimizeResponseProperties,
|
||||
],
|
||||
};
|
||||
|
||||
async supplyData(this: IExecuteFunctions, itemIndex: number): Promise<SupplyData> {
|
||||
const name = this.getNode().name.replace(/ /g, '_');
|
||||
try {
|
||||
tryToParseAlphanumericString(name);
|
||||
} catch (error) {
|
||||
throw new NodeOperationError(
|
||||
this.getNode(),
|
||||
'The name of this tool is not a valid alphanumeric string',
|
||||
{
|
||||
itemIndex,
|
||||
description:
|
||||
"Only alphanumeric characters and underscores are allowed in the tool's name, and the name cannot start with a number",
|
||||
},
|
||||
);
|
||||
}
|
||||
|
||||
const toolDescription = this.getNodeParameter('toolDescription', itemIndex) as string;
|
||||
const sendQuery = this.getNodeParameter('sendQuery', itemIndex, false) as boolean;
|
||||
const sendHeaders = this.getNodeParameter('sendHeaders', itemIndex, false) as boolean;
|
||||
const sendBody = this.getNodeParameter('sendBody', itemIndex, false) as boolean;
|
||||
|
||||
const requestOptions: IHttpRequestOptions = {
|
||||
method: this.getNodeParameter('method', itemIndex, 'GET') as IHttpRequestMethods,
|
||||
url: this.getNodeParameter('url', itemIndex) as string,
|
||||
qs: {},
|
||||
headers: {},
|
||||
body: {},
|
||||
};
|
||||
|
||||
const authentication = this.getNodeParameter('authentication', itemIndex, 'none') as
|
||||
| 'predefinedCredentialType'
|
||||
| 'genericCredentialType'
|
||||
| 'none';
|
||||
|
||||
if (authentication !== 'none') {
|
||||
const domain = new URL(requestOptions.url).hostname;
|
||||
if (domain.includes('{') && domain.includes('}')) {
|
||||
throw new NodeOperationError(
|
||||
this.getNode(),
|
||||
"Can't use a placeholder for the domain when using authentication",
|
||||
{
|
||||
itemIndex,
|
||||
description:
|
||||
'This is for security reasons, to prevent the model accidentally sending your credentials to an unauthorized domain',
|
||||
},
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
const httpRequest = await configureHttpRequestFunction(this, authentication, itemIndex);
|
||||
const optimizeResponse = configureResponseOptimizer(this, itemIndex);
|
||||
|
||||
const rawRequestOptions: { [key: string]: string } = {
|
||||
qs: '',
|
||||
headers: '',
|
||||
body: '',
|
||||
};
|
||||
|
||||
const placeholdersDefinitions = (
|
||||
this.getNodeParameter(
|
||||
'placeholderDefinitions.values',
|
||||
itemIndex,
|
||||
[],
|
||||
) as PlaceholderDefinition[]
|
||||
).map((p) => {
|
||||
if (p.name.startsWith('{') && p.name.endsWith('}')) {
|
||||
p.name = p.name.slice(1, -1);
|
||||
}
|
||||
return p;
|
||||
});
|
||||
|
||||
const toolParameters: ToolParameter[] = [];
|
||||
|
||||
toolParameters.push(
|
||||
...extractParametersFromText(placeholdersDefinitions, requestOptions.url, 'path'),
|
||||
);
|
||||
|
||||
if (sendQuery) {
|
||||
updateParametersAndOptions({
|
||||
ctx: this,
|
||||
itemIndex,
|
||||
toolParameters,
|
||||
placeholdersDefinitions,
|
||||
requestOptions,
|
||||
rawRequestOptions,
|
||||
requestOptionsProperty: 'qs',
|
||||
inputTypePropertyName: 'specifyQuery',
|
||||
jsonPropertyName: 'jsonQuery',
|
||||
parametersPropertyName: 'parametersQuery.values',
|
||||
});
|
||||
}
|
||||
|
||||
if (sendHeaders) {
|
||||
updateParametersAndOptions({
|
||||
ctx: this,
|
||||
itemIndex,
|
||||
toolParameters,
|
||||
placeholdersDefinitions,
|
||||
requestOptions,
|
||||
rawRequestOptions,
|
||||
requestOptionsProperty: 'headers',
|
||||
inputTypePropertyName: 'specifyHeaders',
|
||||
jsonPropertyName: 'jsonHeaders',
|
||||
parametersPropertyName: 'parametersHeaders.values',
|
||||
});
|
||||
}
|
||||
|
||||
if (sendBody) {
|
||||
updateParametersAndOptions({
|
||||
ctx: this,
|
||||
itemIndex,
|
||||
toolParameters,
|
||||
placeholdersDefinitions,
|
||||
requestOptions,
|
||||
rawRequestOptions,
|
||||
requestOptionsProperty: 'body',
|
||||
inputTypePropertyName: 'specifyBody',
|
||||
jsonPropertyName: 'jsonBody',
|
||||
parametersPropertyName: 'parametersBody.values',
|
||||
});
|
||||
}
|
||||
|
||||
for (const placeholder of placeholdersDefinitions) {
|
||||
if (!toolParameters.find((parameter) => parameter.name === placeholder.name)) {
|
||||
throw new NodeOperationError(
|
||||
this.getNode(),
|
||||
`Misconfigured placeholder '${placeholder.name}'`,
|
||||
{
|
||||
itemIndex,
|
||||
description:
|
||||
"This placeholder is defined in the 'Placeholder Definitions' but isn't used anywhere. Either remove the definition, or add the placeholder to a part of the request.",
|
||||
},
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
const func = configureToolFunction(
|
||||
this,
|
||||
itemIndex,
|
||||
toolParameters,
|
||||
requestOptions,
|
||||
rawRequestOptions,
|
||||
httpRequest,
|
||||
optimizeResponse,
|
||||
);
|
||||
|
||||
const description = prepareToolDescription(toolDescription, toolParameters);
|
||||
|
||||
const tool = new DynamicTool({ name, description, func });
|
||||
|
||||
return {
|
||||
response: tool,
|
||||
};
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user