mirror of
https://github.com/czlonkowski/n8n-mcp.git
synced 2026-02-06 05:23:08 +00:00
2e40374da3
Telemetry-driven tool cleanup to improve API clarity: **Removed Tools (9):** - list_nodes - Use search_nodes instead - list_ai_tools - Use search_nodes with isAITool filter - list_tasks - Low usage (0.02%) - get_database_statistics - Use n8n_health_check - list_templates - Use search_templates or get_templates_for_task - get_node_as_tool_info - Documented in get_node - validate_workflow_connections - Use validate_workflow - validate_workflow_expressions - Use validate_workflow - n8n_list_available_tools - Use n8n_health_check - n8n_diagnostic - Merged into n8n_health_check **Consolidated Tool:** - n8n_health_check now supports mode='diagnostic' for detailed troubleshooting **Tool Count:** - Before: 38 tools - After: 31 tools (18% reduction) Concieved by Romuald Członkowski - www.aiadvisors.pl/en 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
556 lines
18 KiB
TypeScript
556 lines
18 KiB
TypeScript
import { ToolDefinition } from '../types';
|
|
|
|
/**
|
|
* n8n Documentation MCP Tools - FINAL OPTIMIZED VERSION
|
|
*
|
|
* Incorporates all lessons learned from real workflow building.
|
|
* Designed to help AI agents avoid common pitfalls and build workflows efficiently.
|
|
*/
|
|
export const n8nDocumentationToolsFinal: ToolDefinition[] = [
|
|
{
|
|
name: 'tools_documentation',
|
|
description: `Get documentation for n8n MCP tools. Call without parameters for quick start guide. Use topic parameter to get documentation for specific tools. Use depth='full' for comprehensive documentation.`,
|
|
inputSchema: {
|
|
type: 'object',
|
|
properties: {
|
|
topic: {
|
|
type: 'string',
|
|
description: 'Tool name (e.g., "search_nodes") or "overview" for general guide. Leave empty for quick reference.',
|
|
},
|
|
depth: {
|
|
type: 'string',
|
|
enum: ['essentials', 'full'],
|
|
description: 'Level of detail. "essentials" (default) for quick reference, "full" for comprehensive docs.',
|
|
default: 'essentials',
|
|
},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: 'search_nodes',
|
|
description: `Search n8n nodes by keyword with optional real-world examples. Pass query as string. Example: query="webhook" or query="database". Returns max 20 results. Use includeExamples=true to get top 2 template configs per node.`,
|
|
inputSchema: {
|
|
type: 'object',
|
|
properties: {
|
|
query: {
|
|
type: 'string',
|
|
description: 'Search terms. Use quotes for exact phrase.',
|
|
},
|
|
limit: {
|
|
type: 'number',
|
|
description: 'Max results (default 20)',
|
|
default: 20,
|
|
},
|
|
mode: {
|
|
type: 'string',
|
|
enum: ['OR', 'AND', 'FUZZY'],
|
|
description: 'OR=any word, AND=all words, FUZZY=typo-tolerant',
|
|
default: 'OR',
|
|
},
|
|
includeExamples: {
|
|
type: 'boolean',
|
|
description: 'Include top 2 real-world configuration examples from popular templates (default: false)',
|
|
default: false,
|
|
},
|
|
},
|
|
required: ['query'],
|
|
},
|
|
},
|
|
{
|
|
name: 'get_node_documentation',
|
|
description: `Get readable docs with examples/auth/patterns. Better than raw schema! 87% coverage. Format: "nodes-base.slack"`,
|
|
inputSchema: {
|
|
type: 'object',
|
|
properties: {
|
|
nodeType: {
|
|
type: 'string',
|
|
description: 'Full type with prefix: "nodes-base.slack"',
|
|
},
|
|
},
|
|
required: ['nodeType'],
|
|
},
|
|
},
|
|
{
|
|
name: 'get_node',
|
|
description: `Get node info with progressive detail levels. Detail: minimal (~200 tokens), standard (~1-2K, default), full (~3-8K). Version modes: versions (history), compare (diff), breaking (changes), migrations (auto-migrate). Supports includeTypeInfo and includeExamples. Use standard for most tasks.`,
|
|
inputSchema: {
|
|
type: 'object',
|
|
properties: {
|
|
nodeType: {
|
|
type: 'string',
|
|
description: 'Full node type: "nodes-base.httpRequest" or "nodes-langchain.agent"',
|
|
},
|
|
detail: {
|
|
type: 'string',
|
|
enum: ['minimal', 'standard', 'full'],
|
|
default: 'standard',
|
|
description: 'Information detail level. standard=essential properties (recommended), full=everything',
|
|
},
|
|
mode: {
|
|
type: 'string',
|
|
enum: ['info', 'versions', 'compare', 'breaking', 'migrations'],
|
|
default: 'info',
|
|
description: 'Operation mode. info=node information, versions=version history, compare/breaking/migrations=version comparison',
|
|
},
|
|
includeTypeInfo: {
|
|
type: 'boolean',
|
|
default: false,
|
|
description: 'Include type structure metadata (type category, JS type, validation rules). Only applies to mode=info. Adds ~80-120 tokens per property.',
|
|
},
|
|
includeExamples: {
|
|
type: 'boolean',
|
|
default: false,
|
|
description: 'Include real-world configuration examples from templates. Only applies to mode=info with detail=standard. Adds ~200-400 tokens per example.',
|
|
},
|
|
fromVersion: {
|
|
type: 'string',
|
|
description: 'Source version for compare/breaking/migrations modes (e.g., "1.0")',
|
|
},
|
|
toVersion: {
|
|
type: 'string',
|
|
description: 'Target version for compare mode (e.g., "2.0"). Defaults to latest if omitted.',
|
|
},
|
|
},
|
|
required: ['nodeType'],
|
|
},
|
|
},
|
|
{
|
|
name: 'search_node_properties',
|
|
description: `Find specific properties in a node (auth, headers, body, etc). Returns paths and descriptions.`,
|
|
inputSchema: {
|
|
type: 'object',
|
|
properties: {
|
|
nodeType: {
|
|
type: 'string',
|
|
description: 'Full type with prefix',
|
|
},
|
|
query: {
|
|
type: 'string',
|
|
description: 'Property to find: "auth", "header", "body", "json"',
|
|
},
|
|
maxResults: {
|
|
type: 'number',
|
|
description: 'Max results (default 20)',
|
|
default: 20,
|
|
},
|
|
},
|
|
required: ['nodeType', 'query'],
|
|
},
|
|
},
|
|
{
|
|
name: 'validate_node_operation',
|
|
description: `Validate n8n node configuration. Pass nodeType as string and config as object. Example: nodeType="nodes-base.slack", config={resource:"channel",operation:"create"}`,
|
|
inputSchema: {
|
|
type: 'object',
|
|
properties: {
|
|
nodeType: {
|
|
type: 'string',
|
|
description: 'Node type as string. Example: "nodes-base.slack"',
|
|
},
|
|
config: {
|
|
type: 'object',
|
|
description: 'Configuration as object. For simple nodes use {}. For complex nodes include fields like {resource:"channel",operation:"create"}',
|
|
},
|
|
profile: {
|
|
type: 'string',
|
|
enum: ['strict', 'runtime', 'ai-friendly', 'minimal'],
|
|
description: 'Profile string: "minimal", "runtime", "ai-friendly", or "strict". Default is "ai-friendly"',
|
|
default: 'ai-friendly',
|
|
},
|
|
},
|
|
required: ['nodeType', 'config'],
|
|
additionalProperties: false,
|
|
},
|
|
outputSchema: {
|
|
type: 'object',
|
|
properties: {
|
|
nodeType: { type: 'string' },
|
|
workflowNodeType: { type: 'string' },
|
|
displayName: { type: 'string' },
|
|
valid: { type: 'boolean' },
|
|
errors: {
|
|
type: 'array',
|
|
items: {
|
|
type: 'object',
|
|
properties: {
|
|
type: { type: 'string' },
|
|
property: { type: 'string' },
|
|
message: { type: 'string' },
|
|
fix: { type: 'string' }
|
|
}
|
|
}
|
|
},
|
|
warnings: {
|
|
type: 'array',
|
|
items: {
|
|
type: 'object',
|
|
properties: {
|
|
type: { type: 'string' },
|
|
property: { type: 'string' },
|
|
message: { type: 'string' },
|
|
suggestion: { type: 'string' }
|
|
}
|
|
}
|
|
},
|
|
suggestions: { type: 'array', items: { type: 'string' } },
|
|
summary: {
|
|
type: 'object',
|
|
properties: {
|
|
hasErrors: { type: 'boolean' },
|
|
errorCount: { type: 'number' },
|
|
warningCount: { type: 'number' },
|
|
suggestionCount: { type: 'number' }
|
|
}
|
|
}
|
|
},
|
|
required: ['nodeType', 'displayName', 'valid', 'errors', 'warnings', 'suggestions', 'summary']
|
|
},
|
|
},
|
|
{
|
|
name: 'validate_node_minimal',
|
|
description: `Check n8n node required fields. Pass nodeType as string and config as empty object {}. Example: nodeType="nodes-base.webhook", config={}`,
|
|
inputSchema: {
|
|
type: 'object',
|
|
properties: {
|
|
nodeType: {
|
|
type: 'string',
|
|
description: 'Node type as string. Example: "nodes-base.slack"',
|
|
},
|
|
config: {
|
|
type: 'object',
|
|
description: 'Configuration object. Always pass {} for empty config',
|
|
},
|
|
},
|
|
required: ['nodeType', 'config'],
|
|
additionalProperties: false,
|
|
},
|
|
outputSchema: {
|
|
type: 'object',
|
|
properties: {
|
|
nodeType: { type: 'string' },
|
|
displayName: { type: 'string' },
|
|
valid: { type: 'boolean' },
|
|
missingRequiredFields: {
|
|
type: 'array',
|
|
items: { type: 'string' }
|
|
}
|
|
},
|
|
required: ['nodeType', 'displayName', 'valid', 'missingRequiredFields']
|
|
},
|
|
},
|
|
{
|
|
name: 'get_property_dependencies',
|
|
description: `Shows property dependencies and visibility rules. Example: sendBody=true reveals body fields. Test visibility with optional config.`,
|
|
inputSchema: {
|
|
type: 'object',
|
|
properties: {
|
|
nodeType: {
|
|
type: 'string',
|
|
description: 'The node type to analyze (e.g., "nodes-base.httpRequest")',
|
|
},
|
|
config: {
|
|
type: 'object',
|
|
description: 'Optional partial configuration to check visibility impact',
|
|
},
|
|
},
|
|
required: ['nodeType'],
|
|
},
|
|
},
|
|
{
|
|
name: 'list_node_templates',
|
|
description: `Find templates using specific nodes. Returns paginated results. Use FULL types: "n8n-nodes-base.httpRequest".`,
|
|
inputSchema: {
|
|
type: 'object',
|
|
properties: {
|
|
nodeTypes: {
|
|
type: 'array',
|
|
items: { type: 'string' },
|
|
description: 'Array of node types to search for (e.g., ["n8n-nodes-base.httpRequest", "n8n-nodes-base.openAi"])',
|
|
},
|
|
limit: {
|
|
type: 'number',
|
|
description: 'Maximum number of templates to return. Default 10.',
|
|
default: 10,
|
|
minimum: 1,
|
|
maximum: 100,
|
|
},
|
|
offset: {
|
|
type: 'number',
|
|
description: 'Pagination offset. Default 0.',
|
|
default: 0,
|
|
minimum: 0,
|
|
},
|
|
},
|
|
required: ['nodeTypes'],
|
|
},
|
|
},
|
|
{
|
|
name: 'get_template',
|
|
description: `Get template by ID. Use mode to control response size: nodes_only (minimal), structure (nodes+connections), full (complete workflow).`,
|
|
inputSchema: {
|
|
type: 'object',
|
|
properties: {
|
|
templateId: {
|
|
type: 'number',
|
|
description: 'The template ID to retrieve',
|
|
},
|
|
mode: {
|
|
type: 'string',
|
|
enum: ['nodes_only', 'structure', 'full'],
|
|
description: 'Response detail level. nodes_only: just node list, structure: nodes+connections, full: complete workflow JSON.',
|
|
default: 'full',
|
|
},
|
|
},
|
|
required: ['templateId'],
|
|
},
|
|
},
|
|
{
|
|
name: 'search_templates',
|
|
description: `Search templates by name/description keywords. Returns paginated results. NOT for node types! For nodes use list_node_templates.`,
|
|
inputSchema: {
|
|
type: 'object',
|
|
properties: {
|
|
query: {
|
|
type: 'string',
|
|
description: 'Search keyword as string. Example: "chatbot"',
|
|
},
|
|
fields: {
|
|
type: 'array',
|
|
items: {
|
|
type: 'string',
|
|
enum: ['id', 'name', 'description', 'author', 'nodes', 'views', 'created', 'url', 'metadata'],
|
|
},
|
|
description: 'Fields to include in response. Default: all fields. Example: ["id", "name"] for minimal response.',
|
|
},
|
|
limit: {
|
|
type: 'number',
|
|
description: 'Maximum number of results. Default 20.',
|
|
default: 20,
|
|
minimum: 1,
|
|
maximum: 100,
|
|
},
|
|
offset: {
|
|
type: 'number',
|
|
description: 'Pagination offset. Default 0.',
|
|
default: 0,
|
|
minimum: 0,
|
|
},
|
|
},
|
|
required: ['query'],
|
|
},
|
|
},
|
|
{
|
|
name: 'get_templates_for_task',
|
|
description: `Curated templates by task. Returns paginated results sorted by popularity.`,
|
|
inputSchema: {
|
|
type: 'object',
|
|
properties: {
|
|
task: {
|
|
type: 'string',
|
|
enum: [
|
|
'ai_automation',
|
|
'data_sync',
|
|
'webhook_processing',
|
|
'email_automation',
|
|
'slack_integration',
|
|
'data_transformation',
|
|
'file_processing',
|
|
'scheduling',
|
|
'api_integration',
|
|
'database_operations'
|
|
],
|
|
description: 'The type of task to get templates for',
|
|
},
|
|
limit: {
|
|
type: 'number',
|
|
description: 'Maximum number of results. Default 10.',
|
|
default: 10,
|
|
minimum: 1,
|
|
maximum: 100,
|
|
},
|
|
offset: {
|
|
type: 'number',
|
|
description: 'Pagination offset. Default 0.',
|
|
default: 0,
|
|
minimum: 0,
|
|
},
|
|
},
|
|
required: ['task'],
|
|
},
|
|
},
|
|
{
|
|
name: 'search_templates_by_metadata',
|
|
description: `Search templates by AI-generated metadata. Filter by category, complexity, setup time, services, or audience. Returns rich metadata for smart template discovery.`,
|
|
inputSchema: {
|
|
type: 'object',
|
|
properties: {
|
|
category: {
|
|
type: 'string',
|
|
description: 'Filter by category (e.g., "automation", "integration", "data processing")',
|
|
},
|
|
complexity: {
|
|
type: 'string',
|
|
enum: ['simple', 'medium', 'complex'],
|
|
description: 'Filter by complexity level',
|
|
},
|
|
maxSetupMinutes: {
|
|
type: 'number',
|
|
description: 'Maximum setup time in minutes',
|
|
minimum: 5,
|
|
maximum: 480,
|
|
},
|
|
minSetupMinutes: {
|
|
type: 'number',
|
|
description: 'Minimum setup time in minutes',
|
|
minimum: 5,
|
|
maximum: 480,
|
|
},
|
|
requiredService: {
|
|
type: 'string',
|
|
description: 'Filter by required service (e.g., "openai", "slack", "google")',
|
|
},
|
|
targetAudience: {
|
|
type: 'string',
|
|
description: 'Filter by target audience (e.g., "developers", "marketers", "analysts")',
|
|
},
|
|
limit: {
|
|
type: 'number',
|
|
description: 'Maximum number of results. Default 20.',
|
|
default: 20,
|
|
minimum: 1,
|
|
maximum: 100,
|
|
},
|
|
offset: {
|
|
type: 'number',
|
|
description: 'Pagination offset. Default 0.',
|
|
default: 0,
|
|
minimum: 0,
|
|
},
|
|
},
|
|
additionalProperties: false,
|
|
},
|
|
},
|
|
{
|
|
name: 'validate_workflow',
|
|
description: `Full workflow validation: structure, connections, expressions, AI tools. Returns errors/warnings/fixes. Essential before deploy.`,
|
|
inputSchema: {
|
|
type: 'object',
|
|
properties: {
|
|
workflow: {
|
|
type: 'object',
|
|
description: 'The complete workflow JSON to validate. Must include nodes array and connections object.',
|
|
},
|
|
options: {
|
|
type: 'object',
|
|
properties: {
|
|
validateNodes: {
|
|
type: 'boolean',
|
|
description: 'Validate individual node configurations. Default true.',
|
|
default: true,
|
|
},
|
|
validateConnections: {
|
|
type: 'boolean',
|
|
description: 'Validate node connections and flow. Default true.',
|
|
default: true,
|
|
},
|
|
validateExpressions: {
|
|
type: 'boolean',
|
|
description: 'Validate n8n expressions syntax and references. Default true.',
|
|
default: true,
|
|
},
|
|
profile: {
|
|
type: 'string',
|
|
enum: ['minimal', 'runtime', 'ai-friendly', 'strict'],
|
|
description: 'Validation profile for node validation. Default "runtime".',
|
|
default: 'runtime',
|
|
},
|
|
},
|
|
description: 'Optional validation settings',
|
|
},
|
|
},
|
|
required: ['workflow'],
|
|
additionalProperties: false,
|
|
},
|
|
outputSchema: {
|
|
type: 'object',
|
|
properties: {
|
|
valid: { type: 'boolean' },
|
|
summary: {
|
|
type: 'object',
|
|
properties: {
|
|
totalNodes: { type: 'number' },
|
|
enabledNodes: { type: 'number' },
|
|
triggerNodes: { type: 'number' },
|
|
validConnections: { type: 'number' },
|
|
invalidConnections: { type: 'number' },
|
|
expressionsValidated: { type: 'number' },
|
|
errorCount: { type: 'number' },
|
|
warningCount: { type: 'number' }
|
|
}
|
|
},
|
|
errors: {
|
|
type: 'array',
|
|
items: {
|
|
type: 'object',
|
|
properties: {
|
|
node: { type: 'string' },
|
|
message: { type: 'string' },
|
|
details: { type: 'string' }
|
|
}
|
|
}
|
|
},
|
|
warnings: {
|
|
type: 'array',
|
|
items: {
|
|
type: 'object',
|
|
properties: {
|
|
node: { type: 'string' },
|
|
message: { type: 'string' },
|
|
details: { type: 'string' }
|
|
}
|
|
}
|
|
},
|
|
suggestions: { type: 'array', items: { type: 'string' } }
|
|
},
|
|
required: ['valid', 'summary']
|
|
},
|
|
},
|
|
];
|
|
|
|
/**
|
|
* QUICK REFERENCE for AI Agents:
|
|
*
|
|
* 1. RECOMMENDED WORKFLOW:
|
|
* - Start: search_nodes → get_node_essentials → get_node_for_task → validate_node_operation
|
|
* - Discovery: list_nodes({category:"trigger"}) for browsing categories
|
|
* - Quick Config: get_node_essentials("nodes-base.httpRequest") - only essential properties
|
|
* - Full Details: get_node_info only when essentials aren't enough
|
|
* - Validation: Use validate_node_operation for complex nodes (Slack, Google Sheets, etc.)
|
|
*
|
|
* 2. COMMON NODE TYPES:
|
|
* Triggers: webhook, schedule, emailReadImap, slackTrigger
|
|
* Core: httpRequest, code, set, if, merge, splitInBatches
|
|
* Integrations: slack, gmail, googleSheets, postgres, mongodb
|
|
* AI: agent, openAi, chainLlm, documentLoader
|
|
*
|
|
* 3. SEARCH TIPS:
|
|
* - search_nodes returns ANY word match (OR logic)
|
|
* - Single words more precise, multiple words broader
|
|
* - If no results: use list_nodes with category filter
|
|
*
|
|
* 4. TEMPLATE SEARCHING:
|
|
* - search_templates("slack") searches template names/descriptions, NOT node types!
|
|
* - To find templates using Slack node: list_node_templates(["n8n-nodes-base.slack"])
|
|
* - For task-based templates: get_templates_for_task("slack_integration")
|
|
* - 399 templates available from the last year
|
|
*
|
|
* 5. KNOWN ISSUES:
|
|
* - Some nodes have duplicate properties with different conditions
|
|
* - Package names: use 'n8n-nodes-base' not '@n8n/n8n-nodes-base'
|
|
* - Check showWhen/hideWhen to identify the right property variant
|
|
*
|
|
* 6. PERFORMANCE:
|
|
* - get_node_essentials: Fast (<5KB)
|
|
* - get_node_info: Slow (100KB+) - use sparingly
|
|
* - search_nodes/list_nodes: Fast, cached
|
|
*/ |