docs: update n8n tools with optimized descriptions and usage tips

src/mcp/tools-update.ts

@@ -1,39 +1,38 @@
 import { ToolDefinition } from '../types';
 
 /**
- * n8n Documentation MCP Tools
+ * n8n Documentation MCP Tools - FINAL OPTIMIZED VERSION
  * 
- * These tools provide read-only access to n8n node documentation, properties,
- * and metadata. They enable AI assistants to understand n8n's capabilities
- * and help users build workflows.
+ * Incorporates all lessons learned from real workflow building.
+ * Designed to help AI agents avoid common pitfalls and build workflows efficiently.
  */
-export const n8nDocumentationTools: ToolDefinition[] = [
+export const n8nDocumentationToolsFinal: ToolDefinition[] = [
   {
     name: 'list_nodes',
-    description: 'List available n8n workflow automation nodes with filtering. Returns node metadata including names, categories, packages, and capabilities. Use this to discover nodes for specific tasks or explore n8n\'s capabilities.',
+    description: `Browse n8n's 525+ nodes by category/type/package. BEST FOR: Initial discovery, browsing categories, finding all nodes of a type. Returns lightweight list with names/descriptions only. Common patterns: list_nodes({category:"trigger"}) for workflow starters, list_nodes({package:"n8n-nodes-base", limit:200}) to see all integrations. Categories: "trigger" (104), "transform" (data processing), "output" (destinations), "input" (data sources). TIP: More reliable than search_nodes for discovery. Use limit:200+ to see all nodes in large categories.`,
     inputSchema: {
       type: 'object',
       properties: {
         package: {
           type: 'string',
-          description: 'Filter by package name (e.g., "n8n-nodes-base" for core nodes, "@n8n/n8n-nodes-langchain" for AI nodes)',
+          description: 'EXACT package name: "n8n-nodes-base" (435 core integrations like Slack, Gmail) or "@n8n/n8n-nodes-langchain" (90 AI nodes). No other values work.',
         },
         category: {
           type: 'string',
-          description: 'Filter by category (e.g., "AI", "Data Transformation", "Communication", "Developer Tools")',
+          description: 'Single category only: "trigger" | "transform" | "output" | "input" | "AI". Returns all nodes in that category.',
         },
         developmentStyle: {
           type: 'string',
           enum: ['declarative', 'programmatic'],
-          description: 'Filter by implementation style - declarative (config-based) or programmatic (code-based)',
+          description: 'Implementation type. Most nodes are "programmatic". Rarely needed.',
         },
         isAITool: {
           type: 'boolean',
-          description: 'Filter to show only nodes with usableAsTool property for AI agent integration',
+          description: 'true = only nodes with usableAsTool for AI agents (263 nodes). Use list_ai_tools instead for better results.',
         },
         limit: {
           type: 'number',
-          description: 'Maximum number of nodes to return',
+          description: 'Results limit. Default 50 may miss nodes - use 200+ for complete results. Max 500.',
           default: 50,
         },
       },
@@ -41,13 +40,13 @@ export const n8nDocumentationTools: ToolDefinition[] = [
   },
   {
     name: 'get_node_info',
-    description: 'Get comprehensive details about a specific n8n node including properties, operations, credentials, documentation, examples, and source code. Essential for understanding node configuration and usage.',
+    description: `Get COMPLETE technical schema for a node. WARNING: Returns massive JSON (often 100KB+) with all properties, operations, credentials. Contains duplicates and complex conditional logic. TIPS: 1) Try get_node_documentation first, 2) Look for "required":true properties, 3) Find properties without "displayOptions" for simpler versions, 4) Check "default" values. Node type MUST include prefix: "nodes-base.httpRequest" NOT "httpRequest". If not found, try lowercase or without prefix.`,
     inputSchema: {
       type: 'object',
       properties: {
         nodeType: {
           type: 'string',
-          description: 'The node type identifier (e.g., "httpRequest", "slack", "code", "agent", "llmChain")',
+          description: 'FULL node type with prefix. Format: "nodes-base.{name}" or "nodes-langchain.{name}". Common examples: "nodes-base.httpRequest", "nodes-base.webhook", "nodes-base.code", "nodes-base.slack", "nodes-base.gmail", "nodes-base.googleSheets", "nodes-base.postgres", "nodes-langchain.openAi", "nodes-langchain.agent". CASE SENSITIVE!',
         },
       },
       required: ['nodeType'],
@@ -55,17 +54,17 @@ export const n8nDocumentationTools: ToolDefinition[] = [
   },
   {
     name: 'search_nodes',
-    description: 'Full-text search across all n8n node documentation, names, and descriptions using SQLite FTS5. Find nodes by functionality, features, or any text content. Returns relevance-ranked results.',
+    description: `Find nodes by keyword. CRITICAL: Use SINGLE WORDS only! Multi-word searches usually fail. The search is substring-based (not semantic). Examples - WORKS: "slack", "email", "sheet", "webhook". FAILS: "send message", "google sheets", "http request". If no results: 1) Try shorter word, 2) Try related terms, 3) Use list_nodes instead. Searches in node names, descriptions, and docs. Returns max 20 by default with relevance scoring.`,
     inputSchema: {
       type: 'object',
       properties: {
         query: {
           type: 'string',
-          description: 'Search keywords to find nodes (e.g., "send email", "AI chat", "database query")',
+          description: 'Search term - MUST BE SINGLE WORD for best results! Good: "slack", "email", "http", "sheet", "database", "webhook". Bad: "send slack message", "read spreadsheet". Case-insensitive.',
         },
         limit: {
           type: 'number',
-          description: 'Maximum number of search results',
+          description: 'Max results. Default 20 is usually enough. Increase if needed.',
           default: 20,
         },
       },
@@ -74,7 +73,7 @@ export const n8nDocumentationTools: ToolDefinition[] = [
   },
   {
     name: 'list_ai_tools',
-    description: 'List all n8n nodes that have the "usableAsTool" property set to true. These nodes can be used by AI agents and LangChain integrations as function-calling tools. Returns AI-specific capabilities and metadata.',
+    description: `List all 263 nodes that AI agents can use as function-calling tools. These have usableAsTool=true and work with OpenAI Assistants, LangChain agents, etc. Simpler than list_nodes - just returns names and descriptions. Great for finding nodes to give AI agents real-world capabilities (send emails, query databases, call APIs). Note: n8n needs N8N_COMMUNITY_PACKAGES_ALLOW_TOOL_USAGE=true.`,
     inputSchema: {
       type: 'object',
       properties: {},
@@ -82,13 +81,13 @@ export const n8nDocumentationTools: ToolDefinition[] = [
   },
   {
     name: 'get_node_documentation',
-    description: 'Get the full parsed documentation for a specific n8n node from the official n8n-docs repository. Returns structured markdown with examples, parameter details, authentication info, and common use cases.',
+    description: `Get human-readable documentation for a node. USE THIS BEFORE get_node_info! Returns markdown with explanations, examples, auth setup, common patterns. Much easier to understand than raw schema. 87% of nodes have docs (returns "No documentation available" otherwise). Same nodeType format as get_node_info. Best for understanding what a node does and how to use it.`,
     inputSchema: {
       type: 'object',
       properties: {
         nodeType: {
           type: 'string',
-          description: 'The node type to retrieve documentation for',
+          description: 'Full node type WITH prefix (same as get_node_info): "nodes-base.slack", "nodes-base.httpRequest", etc. CASE SENSITIVE!',
         },
       },
       required: ['nodeType'],
@@ -96,10 +95,38 @@ export const n8nDocumentationTools: ToolDefinition[] = [
   },
   {
     name: 'get_database_statistics',
-    description: 'Get comprehensive statistics about the n8n node documentation database including total nodes (525+), coverage metrics, AI tools count (263+), package breakdown, and storage size. Useful for understanding data completeness.',
+    description: `Quick summary of the n8n node ecosystem. Shows: total nodes (525), AI tools (263), triggers (104), versioned nodes, documentation coverage (87%), package breakdown. No parameters needed. Useful for verifying MCP is working and understanding available scope.`,
     inputSchema: {
       type: 'object',
       properties: {},
     },
   },
-];
+];
+
+/**
+ * QUICK REFERENCE for AI Agents:
+ * 
+ * 1. DISCOVERY FLOW:
+ *    - Start: get_database_statistics() - see what's available
+ *    - Browse: list_nodes({category:"trigger"}) - find workflow starters  
+ *    - Search: search_nodes({query:"slack"}) - SINGLE WORDS ONLY
+ *    - Learn: get_node_documentation("nodes-base.slack") - understand usage
+ *    - Configure: get_node_info("nodes-base.slack") - get all properties
+ * 
+ * 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:
+ *    - Always use single words
+ *    - Try: service name, action verb, data type
+ *    - If fails: use list_nodes with category
+ * 
+ * 4. PROPERTY TIPS:
+ *    - Look for "required": true first
+ *    - Ignore complex "displayOptions" initially
+ *    - Use "default" values as guidance
+ *    - Simpler properties have no displayOptions
+ */