diff --git a/docs/_images/integrations/builtin/cluster-nodes/toolvectorstore/name-characters-error.png b/docs/_images/integrations/builtin/cluster-nodes/toolvectorstore/name-characters-error.png new file mode 100644 index 000000000..37dcc8139 Binary files /dev/null and b/docs/_images/integrations/builtin/cluster-nodes/toolvectorstore/name-characters-error.png differ diff --git a/docs/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolcode.md b/docs/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolcode.md index 56b4b1227..d103c6e58 100644 --- a/docs/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolcode.md +++ b/docs/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolcode.md @@ -16,10 +16,6 @@ On this page, you'll find the node parameters for the Custom Code Tool node and ## Node parameters -### Name - -Give your custom code a name. It can't contain whitespace. - ### Description Give your custom code a description. This tells the agent when to use this tool. For example: diff --git a/docs/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolvectorstore.md b/docs/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolvectorstore.md index 1e75c7b2d..deaee00da 100644 --- a/docs/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolvectorstore.md +++ b/docs/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolvectorstore.md @@ -19,22 +19,30 @@ For usage examples and templates to help you get started, refer to n8n's [Vector ## Node parameters -### Data Name - -Enter the name of the data in the vector store. - ### Description of Data Enter a description of the data in the vector store. -n8n uses the **Data Name** and **Description of Data** parameters to populate the tool description for AI agents using the following format: - -> Useful for when you need to answer questions about [Data Name]. Whenever you need information about [Description of Data], you should ALWAYS use this. Input should be a fully formed question. - ### Limit The maximum number of results to return. +## How n8n populates the tool description + +n8n uses the node name (select the name to edit) and **Description of Data** parameter to populate the tool description for AI agents using the following format: + +> Useful for when you need to answer questions about [node name]. Whenever you need information about [Description of Data], you should ALWAYS use this. Input should be a fully formed question. + +Spaces in the node name are converted to underscores in the tool description. + +/// warning | Avoid special characters in node names +Using special characters in the node name will cause errors when the agent runs: + +![model errors from special characters](/_images/integrations/builtin/cluster-nodes/toolvectorstore/name-characters-error.png) + +Use only alphanumeric characters, spaces, dashes, and underscores in node names. +/// + ## Related resources View [example workflows and related content](https://n8n.io/integrations/vector-store-tool/){:target=_blank .external-link} on n8n's website. diff --git a/docs/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolworkflow.md b/docs/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolworkflow.md index f974afc35..133936a2d 100644 --- a/docs/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolworkflow.md +++ b/docs/integrations/builtin/cluster-nodes/sub-nodes/n8n-nodes-langchain.toolworkflow.md @@ -16,10 +16,6 @@ On this page, you'll find the node parameters for the Workflow Tool node, and li ## Node parameters -### Name - -Enter a name for your custom code. It can't contain whitespace or special characters. - ### Description Enter a custom code a description. This tells the agent when to use this tool. For example: