list_environments

Display all active QIT test environments for WordPress/WooCommerce plugin testing with compact output format.

Instructions

List all running QIT test environments with compact output.

⚠️ QIT CLI not detected. QIT CLI not found. Please install it using one of these methods:

Via Composer (recommended): composer require woocommerce/qit-cli --dev
Set QIT_CLI_PATH environment variable: export QIT_CLI_PATH=/path/to/qit
Ensure 'qit' is available in your system PATH

For more information, visit: https://github.com/woocommerce/qit-cli

Input Schema

TableJSON Schema

Name	Required	Description	Default
No arguments

Implementation Reference

src/tools/environment.ts:188-261 (handler)

The handler function executes the QIT CLI 'env:list' command, parses its verbose output by splitting into blocks separated by dashed lines, extracts key-value pairs using regex for each environment's details (env_id, created_at, php_version, woocommerce_version, site_url, status), filters out PHP deprecation warnings, and formats the results as a compact Markdown table.

handler: async () => {
  const cmdArgs = ["env:list"];
  const result = await executeQitCommand(cmdArgs);

  // Combine stdout and stderr, filter PHP warnings
  const rawOutput = (result.stdout + "\n" + result.stderr)
    .split("\n")
    .filter(line => !line.includes("Deprecated:") && !line.includes("PHP Deprecated:"))
    .join("\n");

  if (!result.success && !rawOutput.includes("Environment")) {
    return {
      content: result.stderr || result.stdout || "Failed to list environments",
      isError: true,
    };
  }

  // Parse the verbose output into compact format
  // The output has blocks separated by dashed lines, each block has key-value pairs
  const environments: Array<{
    env_id: string;
    created_at: string;
    php_version: string;
    woo_version: string;
    site_url: string;
    status: string;
  }> = [];

  // Split by environment blocks (each starts with "Extra" or similar header)
  const blocks = rawOutput.split(/\s+-{20,}\s+/).filter(block => block.includes("Env_id"));

  for (const block of blocks) {
    const lines = block.split("\n");
    const env: Record<string, string> = {};

    for (const line of lines) {
      // Match key-value pairs like "Env_id                    qitenv01ed18d948bfe5cc"
      const match = line.match(/^\s*([A-Za-z_]+)\s{2,}(.+?)\s*$/);
      if (match) {
        env[match[1].toLowerCase()] = match[2].trim();
      }
    }

    if (env.env_id) {
      environments.push({
        env_id: env.env_id || "",
        created_at: env.created_at || "",
        php_version: env.php_version || "",
        woo_version: env.woocommerce_version || "",
        site_url: env.site_url || "",
        status: env.status || "",
      });
    }
  }

  if (environments.length === 0) {
    return {
      content: "No running environments found.",
      isError: false,
    };
  }

  // Format as compact table
  const header = "| Env ID | Created | PHP | WooCommerce | URL | Status |";
  const separator = "|--------|---------|-----|-------------|-----|--------|";
  const rows = environments.map(env =>
    `| ${env.env_id} | ${env.created_at} | ${env.php_version} | ${env.woo_version} | ${env.site_url} | ${env.status} |`
  );

  return {
    content: `Running environments (${environments.length}):\n${header}\n${separator}\n${rows.join("\n")}`,
    isError: false,
  };
},

src/tools/environment.ts:187-187 (schema)
Input schema defining no required parameters for the list_environments tool.
```
inputSchema: z.object({}),
```

src/tools/environment.ts:184-262 (registration)

Tool definition object for 'list_environments' including name, description, schema, and handler reference.

list_environments: {
  name: "list_environments",
  description: "List all running QIT test environments with compact output.",
  inputSchema: z.object({}),
  handler: async () => {
    const cmdArgs = ["env:list"];
    const result = await executeQitCommand(cmdArgs);

    // Combine stdout and stderr, filter PHP warnings
    const rawOutput = (result.stdout + "\n" + result.stderr)
      .split("\n")
      .filter(line => !line.includes("Deprecated:") && !line.includes("PHP Deprecated:"))
      .join("\n");

    if (!result.success && !rawOutput.includes("Environment")) {
      return {
        content: result.stderr || result.stdout || "Failed to list environments",
        isError: true,
      };
    }

    // Parse the verbose output into compact format
    // The output has blocks separated by dashed lines, each block has key-value pairs
    const environments: Array<{
      env_id: string;
      created_at: string;
      php_version: string;
      woo_version: string;
      site_url: string;
      status: string;
    }> = [];

    // Split by environment blocks (each starts with "Extra" or similar header)
    const blocks = rawOutput.split(/\s+-{20,}\s+/).filter(block => block.includes("Env_id"));

    for (const block of blocks) {
      const lines = block.split("\n");
      const env: Record<string, string> = {};

      for (const line of lines) {
        // Match key-value pairs like "Env_id                    qitenv01ed18d948bfe5cc"
        const match = line.match(/^\s*([A-Za-z_]+)\s{2,}(.+?)\s*$/);
        if (match) {
          env[match[1].toLowerCase()] = match[2].trim();
        }
      }

      if (env.env_id) {
        environments.push({
          env_id: env.env_id || "",
          created_at: env.created_at || "",
          php_version: env.php_version || "",
          woo_version: env.woocommerce_version || "",
          site_url: env.site_url || "",
          status: env.status || "",
        });
      }
    }

    if (environments.length === 0) {
      return {
        content: "No running environments found.",
        isError: false,
      };
    }

    // Format as compact table
    const header = "| Env ID | Created | PHP | WooCommerce | URL | Status |";
    const separator = "|--------|---------|-----|-------------|-----|--------|";
    const rows = environments.map(env =>
      `| ${env.env_id} | ${env.created_at} | ${env.php_version} | ${env.woo_version} | ${env.site_url} | ${env.status} |`
    );

    return {
      content: `Running environments (${environments.length}):\n${header}\n${separator}\n${rows.join("\n")}`,
      isError: false,
    };
  },
},

src/tools/index.ts:15-15 (registration)
Includes environmentTools (containing list_environments) in the central allTools registry by spreading the object.
```
...environmentTools,
```

src/server.ts:25-87 (registration)

Registers all tools from allTools for MCP server: handles ListToolsRequest by providing tool metadata and CallToolRequest by looking up the tool by name, validating input with schema, and invoking the handler.

server.setRequestHandler(ListToolsRequestSchema, async () => {
  // Check if QIT CLI is available
  const cliInfo = detectQitCli();

  const tools = Object.entries(allTools).map(([_, tool]) => ({
    name: tool.name,
    description: cliInfo
      ? tool.description
      : `${tool.description}\n\n⚠️ QIT CLI not detected. ${getQitCliNotFoundError()}`,
    inputSchema: zodToJsonSchema(tool.inputSchema),
  }));

  return { tools };
});

// Handle tool calls
server.setRequestHandler(CallToolRequestSchema, async (request) => {
  const { name, arguments: args } = request.params;

  const tool = allTools[name as ToolName];

  if (!tool) {
    return {
      content: [
        {
          type: "text",
          text: `Unknown tool: ${name}`,
        },
      ],
      isError: true,
    };
  }

  try {
    // Validate input
    const validatedArgs = tool.inputSchema.parse(args);

    // Execute tool
    // eslint-disable-next-line @typescript-eslint/no-explicit-any
    const result = await (tool.handler as (args: any) => Promise<{ content: string; isError: boolean }>)(validatedArgs);

    return {
      content: [
        {
          type: "text",
          text: result.content,
        },
      ],
      isError: result.isError,
    };
  } catch (error) {
    const message = error instanceof Error ? error.message : String(error);
    return {
      content: [
        {
          type: "text",
          text: `Error: ${message}`,
        },
      ],
      isError: true,
    };
  }
});

QIT MCP Server