Skip to main content
Glama

start

Launch the n8n automation server to execute workflows, configure ports, and enable webhook testing tunnels.

Instructions

Start n8n server - replaces "n8n start" command

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
portNoPort to run n8n on (default: 5678)
tunnelNoEnable tunnel for webhook testing

Implementation Reference

  • Core implementation of the 'start' tool: executes 'n8n start' CLI command with optional port and tunnel options, starts in background, and returns success message with URL.
    async startN8n(options: {
      port?: number;
      tunnel?: boolean;
    } = {}): Promise<any> {
      try {
        let command = 'n8n start';
        
        if (options.port) {
          command = `N8N_PORT=${options.port} ${command}`;
        }
        
        if (options.tunnel) {
          command += ' --tunnel';
        }
    
        console.error(`Starting n8n: ${command}`);
        
        // Start n8n in background
        exec(command, (error, stdout, stderr) => {
          if (error) {
            console.error(`n8n error: ${error}`);
          }
        });
    
        // Give it a moment to start
        await new Promise(resolve => setTimeout(resolve, 2000));
    
        const port = options.port || 5678;
        const url = options.tunnel ? 'Check console for tunnel URL' : `http://localhost:${port}`;
    
        return {
          content: [
            {
              type: 'text',
              text: `🚀 n8n started successfully!\n\n` +
                    `🌐 URL: ${url}\n` +
                    `🔧 Port: ${port}\n` +
                    `${options.tunnel ? '🌍 Tunnel: Enabled\n' : ''}` +
                    `\nUse Ctrl+C to stop n8n when done.`,
            },
          ],
        };
      } catch (error: any) {
        throw new Error(`Failed to start n8n: ${error.message}`);
      }
    }
  • ToolHandler.handleTool() switch case that routes 'start' tool calls to N8nManager.startN8n() with parsed arguments.
    case 'start':
      return await this.n8nManager.startN8n({
        port: args?.port as number,
        tunnel: args?.tunnel as boolean,
      });
  • Registers the 'start' MCP tool in getToolDefinitions() array with name, description, and inputSchema.
    {
      name: 'start',
      description: 'Start n8n server - replaces "n8n start" command',
      inputSchema: {
        type: 'object',
        properties: {
          port: {
            type: 'number',
            description: 'Port to run n8n on (default: 5678)',
          },
          tunnel: {
            type: 'boolean',
            description: 'Enable tunnel for webhook testing',
          },
        },
      },
    },
  • Input schema definition for the 'start' tool validating port (number) and tunnel (boolean) parameters.
    inputSchema: {
      type: 'object',
      properties: {
        port: {
          type: 'number',
          description: 'Port to run n8n on (default: 5678)',
        },
        tunnel: {
          type: 'boolean',
          description: 'Enable tunnel for webhook testing',
        },
      },
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It states the action ('Start n8n server') but does not cover critical behavioral aspects such as whether this is a blocking/long-running operation, error handling, permissions required, or side effects. For a server-start tool with zero annotation coverage, this leaves significant gaps in understanding its runtime behavior.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence that front-loads the core purpose and adds clarifying context without redundancy. Every word earns its place, making it appropriately sized and well-structured for quick comprehension.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's moderate complexity (starting a server with optional parameters), no annotations, and no output schema, the description is minimally adequate. It covers the basic purpose but lacks details on behavioral traits, output expectations, or error scenarios. It meets the minimum viable threshold but has clear gaps in completeness for a server management tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, with both parameters ('port', 'tunnel') fully documented in the schema. The description adds no parameter-specific information beyond what the schema provides. According to scoring rules, when schema coverage is high (>80%), the baseline is 3 even with no param info in the description, which applies here.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the specific action ('Start n8n server') and the resource ('n8n server'), with explicit differentiation from the sibling command-line alternative ('replaces "n8n start" command'). This provides a precise verb+resource pairing that distinguishes it from all sibling tools like 'status', 'deploy', or 'execute'.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage context by referencing the command-line alternative, suggesting this tool is for starting the server programmatically. However, it lacks explicit guidance on when to use this versus other server-related tools (e.g., 'deploy', 'status'), prerequisites, or exclusions. The context is implied but not fully articulated.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/mckinleymedia/mcflow-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server