@deepset-ai/n8n-nodes-haystack-enterprise-mcp 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 deepset
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,141 @@
-# Temporary Holding Version
+# @deepset-ai/n8n-nodes-haystack-enterprise-mcp
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+This is an n8n community node. It lets you use pipelines you've enabled as MCP tools on a
+[Haystack Enterprise Platform](https://www.deepset.ai/haystack-platform) workspace as tools for an
+n8n AI Agent.
+
+New to Haystack Enterprise Platform? Start with the
+[getting started guide](https://docs.cloud.deepset.ai/docs/getting-started).
+
+[n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/sustainable-use-license/)
+workflow automation platform.
+
+## Contents
+
+- [Supported n8n versions](#supported-n8n-versions)
+- [Installation](#installation)
+- [Operations](#operations)
+- [Example workflows](#example-workflows)
+- [Credentials](#credentials)
+- [Usage](#usage)
+- [Resources](#resources)
+- [Version history](#version-history)
+- [Contributing](#contributing)
+
+## Supported n8n versions
+
+This package supports n8n 2.16 and later in the 2.x series. We also check the package against the
+latest n8n release.
+
+## Installation
+
+Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in
+the n8n community nodes documentation and enter the package name
+`@deepset-ai/n8n-nodes-haystack-enterprise-mcp`.
+
+This package is **not n8n-verified**: it depends on external libraries (the MCP SDK and LangChain
+core), which verified community nodes can't do. n8n therefore asks you to confirm that you trust the
+package when you install it, and it can't be installed on n8n Cloud. Community nodes must be enabled
+on your n8n instance. For the verified Haystack Enterprise nodes, see
+[`@deepset-ai/n8n-nodes-haystack-enterprise`](https://www.npmjs.com/package/@deepset-ai/n8n-nodes-haystack-enterprise).
+
+**This node is only supported on self-hosted n8n.** It is not available on n8n Cloud and refuses to
+run there (the node checks n8n's own `N8N_DEPLOYMENT_TYPE` environment variable at runtime).
+
+## Operations
+
+The node connects to a Haystack Enterprise Platform MCP server and exposes its enabled pipelines to
+an n8n AI Agent as tools:
+
+- **Workspace** — select which Haystack Enterprise Platform workspace's MCP server to connect to.
+- **Tools to Include** — choose how to select which of the workspace's enabled pipeline tools are
+  exposed to the AI Agent: **All** (expose every tool), **Selected** (only expose the tools listed
+  in **Tools to Include**), or **All Except** (expose all tools except those listed in **Tools to
+  Exclude**).
+- **Options → Timeout** — how long (in ms) to wait for a pipeline call to finish before failing it
+  (default 60000).
+
+## Example workflows
+
+The example workflow is not part of the npm package. It lives in the repository, in
+[`packages/haystack-enterprise-mcp/test/examples/`](https://github.com/deepset-ai/deepset-n8n-nodes/tree/main/packages/haystack-enterprise-mcp/test/examples):
+
+- [`ai-agent-with-mcp-tools-example.json`](./test/examples/ai-agent-with-mcp-tools-example.json) —
+  an AI Agent with this node wired into its Tools input, exposing the workspace's enabled pipelines
+  directly to the agent.
+
+To use it, either open the file on GitHub, click **Copy raw file**, and paste it onto the n8n canvas
+(Ctrl/Cmd+V), or clone the repository and, in the n8n editor, open the menu (**⋮** in the top right)
+→ **Import from File** and select the JSON file. You'll still need to fill in your own credentials
+(including the OpenAI Chat Model node's) and select your own workspace on the Haystack Enterprise
+MCP node.
+
+## Credentials
+
+The node's **Authentication** dropdown offers two ways to authenticate.
+
+### API Key
+
+Choose **API Key** on the node (the default) and create a "Haystack Enterprise API" credential:
+
+1. In [Haystack Enterprise Platform](https://cloud.deepset.ai/), go to Settings → API Keys and
+   generate a key. See [Generate an API key](https://docs.cloud.deepset.ai/docs/generate-api-key).
+2. In n8n, paste the key into the credential. **Server URL** defaults to the hosted Haystack
+   Enterprise Platform API (`https://api.cloud.deepset.ai`); for dev or private environments, set it
+   to your instance's API origin.
+
+The key needs at least workspace and search permissions.
+
+### OAuth2 (sign in with your Haystack Enterprise account)
+
+OAuth2 credentials require n8n 2.19.2 or later.
+
+Choose **OAuth2** on the node and create a "Haystack Enterprise OAuth2 API" credential.
+
+1. Leave **Server URL** at `https://api.cloud.deepset.ai`. The Server URL is the API origin the
+   nodes use for requests and OAuth2 discovery; change it only for dev or private Haystack
+   Enterprise deployments.
+2. Click **Connect** and sign in with your Haystack Enterprise account.
+
+**Manual OAuth2 configuration.** Turn **Use Dynamic Client Registration** off to configure or reuse
+an existing OAuth2 client, including clients for private Haystack Enterprise deployments. Keep
+**Server URL** pointed at the Haystack Enterprise API, fill in the OAuth2 settings, and register the
+callback URL shown on the credential as a redirect URI on the client. Leave **Client Secret** empty
+for a public PKCE client; confidential clients still require their secret.
+
+## Usage
+
+Add the node to an AI Agent's Tools input. Select your workspace, optionally restrict which pipeline
+tools are exposed, and the Agent can then call your enabled pipelines directly.
+
+### Testing a pipeline directly
+
+You can also call one pipeline directly, without an Agent, by using the node's "Execute step" test
+button: pass in an item shaped like `{ "tool": "<pipeline name>", ...arguments }` and it calls that
+pipeline and returns its response. This is meant for smoke-testing the MCP connection and a
+pipeline's arguments, not for wiring into a live workflow — this node has no Main input/output, so
+it can't be connected as a regular step between other nodes (only via an AI Agent's Tools input, or
+via "Execute step").
+
+### "Custom API Call" option
+
+You'll see a "Custom API Call" option at the bottom of some dropdowns. This is added automatically
+by n8n to any node with a token/API-key credential — it's not something this node adds, and it has
+no effect here. You can safely ignore it.
+
+## Resources
+
+- [n8n community nodes documentation](https://docs.n8n.io/integrations/#community-nodes)
+- [Use your pipelines as MCP tools](https://docs.cloud.deepset.ai/docs/use-pipeline-as-mcp-tool)
+- [Haystack Enterprise Platform](https://cloud.deepset.ai/)
+- [Haystack Enterprise Platform docs](https://docs.cloud.deepset.ai/)
+
+## Version history
+
+See the [changelog](./CHANGELOG.md).
+
+## Contributing
+
+See [CONTRIBUTING.md](https://github.com/deepset-ai/deepset-n8n-nodes/blob/main/CONTRIBUTING.md).
+Report security issues as described in
+[SECURITY.md](https://github.com/deepset-ai/deepset-n8n-nodes/blob/main/SECURITY.md).

package/dist/credentials/HaystackEnterpriseApi.credentials.d.ts

@@ -0,0 +1,10 @@
+import type { IAuthenticateGeneric, ICredentialTestRequest, ICredentialType, INodeProperties } from 'n8n-workflow';
+export declare class HaystackEnterpriseApi implements ICredentialType {
+    name: string;
+    displayName: string;
+    icon: "file:../nodes/HaystackEnterpriseMcp/haystack-enterprise-electric-blue.svg";
+    documentationUrl: string;
+    properties: INodeProperties[];
+    authenticate: IAuthenticateGeneric;
+    test: ICredentialTestRequest;
+}

package/dist/credentials/HaystackEnterpriseApi.credentials.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HaystackEnterpriseApi = void 0;
+class HaystackEnterpriseApi {
+    name = 'haystackEnterpriseApi';
+    displayName = 'Haystack Enterprise API';
+    icon = 'file:../nodes/HaystackEnterpriseMcp/haystack-enterprise-electric-blue.svg';
+    documentationUrl = 'https://docs.cloud.deepset.ai/docs/generate-api-key';
+    properties = [
+        {
+            displayName: 'Server URL',
+            name: 'serverUrl',
+            type: 'string',
+            default: 'https://api.cloud.deepset.ai',
+            placeholder: 'https://api.cloud.deepset.ai',
+            description: 'The Haystack Enterprise API origin. Use the default for the hosted Haystack Enterprise Platform; for dev or private environments, enter your instance API origin (for example <code>https://haystack.example.com</code>).',
+        },
+        {
+            displayName: 'API Key',
+            name: 'apiKey',
+            type: 'string',
+            typeOptions: { password: true },
+            default: '',
+            required: true,
+            description: 'Your Haystack Enterprise <a href="https://docs.cloud.deepset.ai/docs/generate-api-key/" target="_blank" rel="noopener noreferrer">API key</a>. Generate one in Haystack Enterprise Platform under Settings → API Keys.',
+        },
+    ];
+    authenticate = {
+        type: 'generic',
+        properties: {
+            headers: {
+                Authorization: '=Bearer {{$credentials.apiKey}}',
+            },
+        },
+    };
+    test = {
+        request: {
+            baseURL: '={{ ((($credentials.serverUrl || "https://api.cloud.deepset.ai").trim().replace(/\\/+$/,"").replace(/\\/api\\/v[12]$/i,"")) || "https://api.cloud.deepset.ai") }}/api/v1',
+            url: '/workspaces',
+            method: 'GET',
+        },
+        rules: [
+            {
+                type: 'responseCode',
+                properties: {
+                    value: 401,
+                    message: 'Invalid API key. Check your key in Haystack Enterprise Platform under Settings → API Keys.',
+                },
+            },
+            {
+                type: 'responseCode',
+                properties: {
+                    value: 403,
+                    message: 'Access denied. The API key may not have permission to list workspaces.',
+                },
+            },
+        ],
+    };
+}
+exports.HaystackEnterpriseApi = HaystackEnterpriseApi;
+//# sourceMappingURL=HaystackEnterpriseApi.credentials.js.map

package/dist/credentials/HaystackEnterpriseApi.credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HaystackEnterpriseApi.credentials.js","sourceRoot":"","sources":["../../credentials/HaystackEnterpriseApi.credentials.ts"],"names":[],"mappings":";;;AASA,MAAa,qBAAqB;IACjC,IAAI,GAAG,uBAAuB,CAAC;IAE/B,WAAW,GAAG,yBAAyB,CAAC;IAExC,IAAI,GAAG,2EAAoF,CAAC;IAE5F,gBAAgB,GAAG,qDAAqD,CAAC;IAEzE,UAAU,GAAsB;QAC/B;YACC,WAAW,EAAE,YAAY;YACzB,IAAI,EAAE,WAAW;YACjB,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,8BAA8B;YACvC,WAAW,EAAE,8BAA8B;YAC3C,WAAW,EACV,2NAA2N;SAC5N;QACD;YACC,WAAW,EAAE,SAAS;YACtB,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE;YAC/B,OAAO,EAAE,EAAE;YACX,QAAQ,EAAE,IAAI;YACd,WAAW,EACV,wNAAwN;SACzN;KACD,CAAC;IAEF,YAAY,GAAyB;QACpC,IAAI,EAAE,SAAS;QACf,UAAU,EAAE;YACX,OAAO,EAAE;gBACR,aAAa,EAAE,iCAAiC;aAChD;SACD;KACD,CAAC;IAEF,IAAI,GAA2B;QAC9B,OAAO,EAAE;YACR,OAAO,EACN,0KAA0K;YAC3K,GAAG,EAAE,aAAa;YAClB,MAAM,EAAE,KAAK;SACb;QACD,KAAK,EAAE;YACN;gBACC,IAAI,EAAE,cAAc;gBACpB,UAAU,EAAE;oBACX,KAAK,EAAE,GAAG;oBACV,OAAO,EACN,4FAA4F;iBAC7F;aACD;YACD;gBACC,IAAI,EAAE,cAAc;gBACpB,UAAU,EAAE;oBACX,KAAK,EAAE,GAAG;oBACV,OAAO,EAAE,wEAAwE;iBACjF;aACD;SACD;KACD,CAAC;CACF;AAjED,sDAiEC"}

package/dist/credentials/HaystackEnterpriseOAuth2Api.credentials.d.ts

@@ -0,0 +1,9 @@
+import type { ICredentialType, INodeProperties } from 'n8n-workflow';
+export declare class HaystackEnterpriseOAuth2Api implements ICredentialType {
+    name: string;
+    extends: string[];
+    displayName: string;
+    icon: "file:../nodes/HaystackEnterpriseMcp/haystack-enterprise-electric-blue.svg";
+    documentationUrl: string;
+    properties: INodeProperties[];
+}

package/dist/credentials/HaystackEnterpriseOAuth2Api.credentials.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HaystackEnterpriseOAuth2Api = void 0;
+class HaystackEnterpriseOAuth2Api {
+    name = 'haystackEnterpriseOAuth2Api';
+    extends = ['oAuth2Api'];
+    displayName = 'Haystack Enterprise OAuth2 API';
+    icon = 'file:../nodes/HaystackEnterpriseMcp/haystack-enterprise-electric-blue.svg';
+    documentationUrl = 'https://github.com/deepset-ai/deepset-n8n-nodes/tree/main/packages/haystack-enterprise-mcp#credentials';
+    properties = [
+        {
+            displayName: 'Click <b>Connect</b> below and sign in with your Haystack Enterprise account. n8n registers itself with Haystack Enterprise automatically.',
+            name: 'dynamicClientRegistrationNotice',
+            type: 'notice',
+            default: '',
+            displayOptions: { show: { useDynamicClientRegistration: [true] } },
+        },
+        {
+            displayName: 'Use Dynamic Client Registration',
+            name: 'useDynamicClientRegistration',
+            type: 'boolean',
+            default: true,
+            description: 'Whether to let n8n register itself as an OAuth2 client automatically (RFC 7591); turn this off to configure or reuse an OAuth2 client manually.',
+        },
+        {
+            displayName: 'Server URL',
+            name: 'serverUrl',
+            type: 'string',
+            default: 'https://api.cloud.deepset.ai',
+            required: true,
+            description: 'The Haystack Enterprise API origin (for example, https://api.cloud.deepset.ai).',
+        },
+        {
+            displayName: 'Scope',
+            name: 'scope',
+            type: 'string',
+            default: 'openid profile email offline_access',
+            displayOptions: { show: { useDynamicClientRegistration: [false] } },
+            description: 'The OAuth2 scopes requested when using a manually configured client.',
+        },
+        {
+            displayName: 'Client Secret',
+            name: 'clientSecret',
+            type: 'string',
+            typeOptions: { password: true },
+            default: '',
+            required: false,
+            displayOptions: { show: { useDynamicClientRegistration: [false] } },
+            description: 'Optional for public PKCE clients; required for confidential OAuth2 clients.',
+        },
+    ];
+}
+exports.HaystackEnterpriseOAuth2Api = HaystackEnterpriseOAuth2Api;
+//# sourceMappingURL=HaystackEnterpriseOAuth2Api.credentials.js.map

package/dist/credentials/HaystackEnterpriseOAuth2Api.credentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HaystackEnterpriseOAuth2Api.credentials.js","sourceRoot":"","sources":["../../credentials/HaystackEnterpriseOAuth2Api.credentials.ts"],"names":[],"mappings":";;;AAMA,MAAa,2BAA2B;IACvC,IAAI,GAAG,6BAA6B,CAAC;IAErC,OAAO,GAAG,CAAC,WAAW,CAAC,CAAC;IAExB,WAAW,GAAG,gCAAgC,CAAC;IAE/C,IAAI,GAAG,2EAAoF,CAAC;IAE5F,gBAAgB,GACf,wGAAwG,CAAC;IAE1G,UAAU,GAAsB;QAC/B;YACC,WAAW,EACV,4IAA4I;YAC7I,IAAI,EAAE,iCAAiC;YACvC,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,EAAE;YACX,cAAc,EAAE,EAAE,IAAI,EAAE,EAAE,4BAA4B,EAAE,CAAC,IAAI,CAAC,EAAE,EAAE;SAClE;QACD;YAEC,WAAW,EAAE,iCAAiC;YAC9C,IAAI,EAAE,8BAA8B;YACpC,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;YACb,WAAW,EACV,iJAAiJ;SAClJ;QACD;YAEC,WAAW,EAAE,YAAY;YACzB,IAAI,EAAE,WAAW;YACjB,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,8BAA8B;YACvC,QAAQ,EAAE,IAAI;YACd,WAAW,EACV,iFAAiF;SAClF;QACD;YACC,WAAW,EAAE,OAAO;YACpB,IAAI,EAAE,OAAO;YACb,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,qCAAqC;YAC9C,cAAc,EAAE,EAAE,IAAI,EAAE,EAAE,4BAA4B,EAAE,CAAC,KAAK,CAAC,EAAE,EAAE;YACnE,WAAW,EAAE,sEAAsE;SACnF;QACD;YACC,WAAW,EAAE,eAAe;YAC5B,IAAI,EAAE,cAAc;YACpB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE;YAC/B,OAAO,EAAE,EAAE;YACX,QAAQ,EAAE,KAAK;YACf,cAAc,EAAE,EAAE,IAAI,EAAE,EAAE,4BAA4B,EAAE,CAAC,KAAK,CAAC,EAAE,EAAE;YACnE,WAAW,EAAE,6EAA6E;SAC1F;KACD,CAAC;CACF;AA3DD,kEA2DC"}

package/dist/nodes/HaystackEnterpriseMcp/HaystackEnterpriseMcp.node.d.ts

@@ -0,0 +1,12 @@
+import type { IExecuteFunctions, ILoadOptionsFunctions, INodeExecutionData, INodePropertyOptions, INodeType, INodeTypeDescription, ISupplyDataFunctions, SupplyData } from 'n8n-workflow';
+export declare class HaystackEnterpriseMcp implements INodeType {
+    description: INodeTypeDescription;
+    methods: {
+        loadOptions: {
+            getWorkspaces(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]>;
+            getAvailableMcpTools(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]>;
+        };
+    };
+    supplyData(this: ISupplyDataFunctions, itemIndex: number): Promise<SupplyData>;
+    execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]>;
+}