feat: complete modular documentation system for all MCP tools (#60)

- Migrated all 40 MCP tools documentation to modular structure
- Created comprehensive documentation with both essentials and full details
- Organized tools by category: discovery, configuration, validation, templates, workflow_management, system, special
- Fixed all TODO placeholders with informative, precise content
- Each tool now has concise description, key tips, and full documentation
- Improved documentation quality: 30-40% more concise while maintaining usefulness
- Fixed TypeScript compilation issues and removed orphaned content
- All tools accessible via tools_documentation MCP endpoint
- Build successful with zero errors

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
czlonkowski
2025-07-17 18:39:29 +02:00
parent 8025d31e63
commit c1a6347d4f
53 changed files with 2744 additions and 1322 deletions

View File

@@ -0,0 +1,78 @@
import { ToolDocumentation } from '../types';
export const n8nTriggerWebhookWorkflowDoc: ToolDocumentation = {
name: 'n8n_trigger_webhook_workflow',
category: 'workflow_management',
essentials: {
description: 'Trigger workflow via webhook. Must be ACTIVE with Webhook node. Method must match config.',
keyParameters: ['webhookUrl', 'httpMethod', 'data'],
example: 'n8n_trigger_webhook_workflow({webhookUrl: "https://n8n.example.com/webhook/abc-def-ghi"})',
performance: 'Immediate trigger, response time depends on workflow complexity',
tips: [
'Workflow MUST be active and contain a Webhook node for triggering',
'HTTP method must match webhook node configuration (often GET)',
'Use waitForResponse:false for async execution without waiting'
]
},
full: {
description: `Triggers a workflow execution via its webhook URL. This is the primary method for external systems to start n8n workflows. The target workflow must be active and contain a properly configured Webhook node as the trigger. The HTTP method used must match the webhook configuration.`,
parameters: {
webhookUrl: {
type: 'string',
required: true,
description: 'Full webhook URL from n8n workflow (e.g., https://n8n.example.com/webhook/abc-def-ghi)'
},
httpMethod: {
type: 'string',
required: false,
enum: ['GET', 'POST', 'PUT', 'DELETE'],
description: 'HTTP method (must match webhook configuration, often GET). Defaults to GET if not specified'
},
data: {
type: 'object',
required: false,
description: 'Data to send with the webhook request. For GET requests, becomes query parameters'
},
headers: {
type: 'object',
required: false,
description: 'Additional HTTP headers to include in the request'
},
waitForResponse: {
type: 'boolean',
required: false,
description: 'Wait for workflow completion and return results (default: true). Set to false for fire-and-forget'
}
},
returns: `Webhook response data if waitForResponse is true, or immediate acknowledgment if false. Response format depends on webhook node configuration.`,
examples: [
'n8n_trigger_webhook_workflow({webhookUrl: "https://n8n.example.com/webhook/order-process"}) - Trigger with GET',
'n8n_trigger_webhook_workflow({webhookUrl: "https://n8n.example.com/webhook/data-import", httpMethod: "POST", data: {name: "John", email: "john@example.com"}}) - POST with data',
'n8n_trigger_webhook_workflow({webhookUrl: "https://n8n.example.com/webhook/async-job", waitForResponse: false}) - Fire and forget',
'n8n_trigger_webhook_workflow({webhookUrl: "https://n8n.example.com/webhook/api", headers: {"API-Key": "secret"}}) - With auth headers'
],
useCases: [
'Trigger data processing workflows from external applications',
'Start scheduled jobs manually via webhook',
'Integrate n8n workflows with third-party services',
'Create REST API endpoints using n8n workflows',
'Implement event-driven architectures with n8n'
],
performance: `Performance varies based on workflow complexity and waitForResponse setting. Synchronous calls (waitForResponse: true) block until workflow completes. For long-running workflows, use async mode (waitForResponse: false) and monitor execution separately.`,
bestPractices: [
'Always verify workflow is active before attempting webhook triggers',
'Match HTTP method exactly with webhook node configuration',
'Use async mode (waitForResponse: false) for long-running workflows',
'Include authentication headers when webhook requires them',
'Test webhook URL manually first to ensure it works'
],
pitfalls: [
'Workflow must be ACTIVE - inactive workflows cannot be triggered',
'HTTP method mismatch returns 404 even if URL is correct',
'Webhook node must be the trigger node in the workflow',
'Timeout errors occur with long workflows in sync mode',
'Data format must match webhook node expectations'
],
relatedTools: ['n8n_get_execution', 'n8n_list_executions', 'n8n_get_workflow', 'n8n_create_workflow']
}
};