mirror of
https://github.com/czlonkowski/n8n-mcp.git
synced 2026-02-06 21:43:07 +00:00
refactor: rewrite all MCP tool documentation for AI agent optimization
- Redesigned documentation to be utilitarian and AI-agent focused - Removed all pleasantries, emojis, and conversational language - Added concrete numbers throughout (528 nodes, 108 triggers, 264 AI tools) - Updated all tool descriptions with practical, actionable information - Enhanced examples with actual return structures and usage patterns - Made Code node guides prominently featured in overview - Verified documentation accuracy through extensive testing - Standardized format across all 30+ tool documentation files Documentation now optimized for token efficiency while maintaining clarity and completeness for AI agent consumption. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
@@ -24,8 +24,53 @@ export const n8nCreateWorkflowDoc: ToolDocumentation = {
|
||||
},
|
||||
returns: 'Created workflow object with id, name, nodes, connections, active status',
|
||||
examples: [
|
||||
'n8n_create_workflow({name: "Webhook to Slack", nodes: [...], connections: {...}}) - Basic workflow',
|
||||
'n8n_create_workflow({name: "Data ETL", nodes: [...], connections: {...], settings: {timezone: "UTC"}}) - With settings'
|
||||
`// Basic webhook to Slack workflow
|
||||
n8n_create_workflow({
|
||||
name: "Webhook to Slack",
|
||||
nodes: [
|
||||
{
|
||||
id: "webhook_1",
|
||||
name: "Webhook",
|
||||
type: "n8n-nodes-base.webhook",
|
||||
typeVersion: 1,
|
||||
position: [250, 300],
|
||||
parameters: {
|
||||
httpMethod: "POST",
|
||||
path: "slack-notify"
|
||||
}
|
||||
},
|
||||
{
|
||||
id: "slack_1",
|
||||
name: "Slack",
|
||||
type: "n8n-nodes-base.slack",
|
||||
typeVersion: 1,
|
||||
position: [450, 300],
|
||||
parameters: {
|
||||
resource: "message",
|
||||
operation: "post",
|
||||
channel: "#general",
|
||||
text: "={{$json.message}}"
|
||||
}
|
||||
}
|
||||
],
|
||||
connections: {
|
||||
"webhook_1": {
|
||||
"main": [[{node: "slack_1", type: "main", index: 0}]]
|
||||
}
|
||||
}
|
||||
})`,
|
||||
`// Workflow with settings and error handling
|
||||
n8n_create_workflow({
|
||||
name: "Data Processing",
|
||||
nodes: [...],
|
||||
connections: {...},
|
||||
settings: {
|
||||
timezone: "America/New_York",
|
||||
errorWorkflow: "error_handler_workflow_id",
|
||||
saveDataSuccessExecution: "all",
|
||||
saveDataErrorExecution: "all"
|
||||
}
|
||||
})`
|
||||
],
|
||||
useCases: [
|
||||
'Deploy validated workflows',
|
||||
@@ -41,10 +86,11 @@ export const n8nCreateWorkflowDoc: ToolDocumentation = {
|
||||
'Test with n8n_trigger_webhook_workflow'
|
||||
],
|
||||
pitfalls: [
|
||||
'Requires API configuration',
|
||||
'Created workflows are inactive',
|
||||
'Node IDs must be unique',
|
||||
'Credentials configured separately'
|
||||
'**REQUIRES N8N_API_URL and N8N_API_KEY environment variables** - tool unavailable without n8n API access',
|
||||
'Workflows created in INACTIVE state - must activate separately',
|
||||
'Node IDs must be unique within workflow',
|
||||
'Credentials must be configured separately in n8n',
|
||||
'Node type names must include package prefix (e.g., "n8n-nodes-base.slack")'
|
||||
],
|
||||
relatedTools: ['validate_workflow', 'n8n_update_partial_workflow', 'n8n_trigger_webhook_workflow']
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user