Back to N8n

Node Usable As Tool

packages/@n8n/eslint-plugin-community-nodes/docs/rules/node-usable-as-tool.md

1.37.21.1 KB
Original Source

Ensure node classes have usableAsTool property (@n8n/community-nodes/node-usable-as-tool)

šŸ’¼ This rule is enabled in the following configs: āœ… recommended, ā˜‘ļø recommendedWithoutN8nCloudSupport.

šŸ”§ This rule is automatically fixable by the --fix CLI option.

<!-- end auto-generated rule header -->

Rule Details

Ensures your nodes declare whether they can be used as tools in AI workflows. This property helps n8n determine if your node is suitable for AI-assisted automation.

Examples

āŒ Incorrect

typescript
export class MyNode implements INodeType {
  description: INodeTypeDescription = {
    displayName: 'My Node',
    name: 'myNode',
    group: ['input'],
    version: 1,
    // Missing usableAsTool property
    properties: [],
  };
}

āœ… Correct

typescript
export class MyNode implements INodeType {
  description: INodeTypeDescription = {
    displayName: 'My Node',
    name: 'myNode',
    group: ['input'],
    version: 1,
    usableAsTool: true,
    properties: [],
  };
}