feat(SearXNG Node): Add SearXNG tool (#13218)

2025-12-21 11:49:59 +00:00 · 2025-04-10 14:37:54 +02:00
parent 965baae093
commit 0b460552ba
4 changed files with 147 additions and 0 deletions
--- a/packages/@n8n/nodes-langchain/nodes/tools/ToolSearXng/ToolSearXng.node.ts
+++ b/packages/@n8n/nodes-langchain/nodes/tools/ToolSearXng/ToolSearXng.node.ts
@@ -0,0 +1,125 @@
+import { SearxngSearch } from '@langchain/community/tools/searxng_search';
+import { NodeConnectionTypes } from 'n8n-workflow';
+import type {
+	INodeType,
+	INodeTypeDescription,
+	ISupplyDataFunctions,
+	SupplyData,
+} from 'n8n-workflow';
+
+import { logWrapper } from '@utils/logWrapper';
+import { getConnectionHintNoticeField } from '@utils/sharedFields';
+
+type Options = {
+	numResults: number;
+	pageNumber: number;
+	language: string;
+	safesearch: 0 | 1 | 2;
+};
+
+export class ToolSearXng implements INodeType {
+	description: INodeTypeDescription = {
+		displayName: 'SearXNG',
+		name: 'toolSearXng',
+		icon: 'file:searXng.svg',
+		group: ['transform'],
+		version: 1,
+		description: 'Search in SearXNG',
+		defaults: {
+			name: 'SearXNG',
+		},
+		codex: {
+			categories: ['AI'],
+			subcategories: {
+				AI: ['Tools'],
+				Tools: ['Other Tools'],
+			},
+			resources: {
+				primaryDocumentation: [
+					{
+						url: 'https://docs.n8n.io/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolsearxng',
+					},
+				],
+			},
+		},
+		inputs: [],
+		outputs: [NodeConnectionTypes.AiTool],
+		outputNames: ['Tool'],
+		credentials: [
+			{
+				name: 'searXngApi',
+				required: true,
+			},
+		],
+		properties: [
+			getConnectionHintNoticeField([NodeConnectionTypes.AiAgent]),
+			{
+				displayName: 'Options',
+				name: 'options',
+				type: 'collection',
+				placeholder: 'Add Option',
+				default: {},
+				options: [
+					{
+						displayName: 'Number of Results',
+						name: 'numResults',
+						type: 'number',
+						default: 10,
+					},
+					{
+						displayName: 'Search Page Number',
+						name: 'pageNumber',
+						type: 'number',
+						default: 1,
+					},
+					{
+						displayName: 'Language',
+						name: 'language',
+						type: 'string',
+						default: 'en',
+						description:
+							'Defines the language to use. It\'s a two-letter language code. (e.g., `en` for English, `es` for Spanish, or `fr` for French). Head to <a href="https://docs.searxng.org/user/search-syntax.html#select-language">SearXNG search syntax page</a> for more info.',
+					},
+					{
+						displayName: 'Safe Search',
+						name: 'safesearch',
+						type: 'options',
+						options: [
+							{
+								name: 'None',
+								value: 0,
+							},
+							{
+								name: 'Moderate',
+								value: 1,
+							},
+							{
+								name: 'Strict',
+								value: 2,
+							},
+						],
+						default: 0,
+						description: 'Filter search results of engines which support safe search',
+					},
+				],
+			},
+		],
+	};
+
+	async supplyData(this: ISupplyDataFunctions, itemIndex: number): Promise<SupplyData> {
+		const credentials = await this.getCredentials<{ apiUrl: string }>('searXngApi');
+		const options = this.getNodeParameter('options', itemIndex) as Options;
+
+		const tool = new SearxngSearch({
+			apiBase: credentials.apiUrl,
+			headers: {
+				Accept: 'application/json',
+			},
+			params: options,
+		});
+
+		return {
+			response: logWrapper(tool, this),
+		};
+	}
+}