Skip to main content
Glama

validate_zip

Validate ZIP files for WordPress plugins or themes to check content integrity and ensure they meet required standards.

Instructions

Validate a local plugin or theme ZIP file's content.

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

  1. Via Composer (recommended): composer require woocommerce/qit-cli --dev

  2. Set QIT_CLI_PATH environment variable: export QIT_CLI_PATH=/path/to/qit

  3. Ensure 'qit' is available in your system PATH

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

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesPath to the ZIP file to validate

Implementation Reference

  • The handler function for the 'validate_zip' tool. It constructs CLI arguments for 'woo:validate-zip' using the provided path and delegates execution to executeAndFormat.
    handler: async (args: { path: string }) => {
      const cmdArgs = ["woo:validate-zip", args.path];
      return executeAndFormat(cmdArgs);
    },
  • Input schema using Zod, defining a required 'path' parameter as a string describing the ZIP file location.
    inputSchema: z.object({
      path: z.string().describe("Path to the ZIP file to validate"),
    }),
  • Full tool definition object for 'validate_zip' registered as a property in the utilitiesTools export.
    validate_zip: {
      name: "validate_zip",
      description: "Validate a local plugin or theme ZIP file's content.",
      inputSchema: z.object({
        path: z.string().describe("Path to the ZIP file to validate"),
      }),
      handler: async (args: { path: string }) => {
        const cmdArgs = ["woo:validate-zip", args.path];
        return executeAndFormat(cmdArgs);
      },
    },
  • Incorporates utilitiesTools (containing validate_zip) into the aggregated allTools export used by the MCP server.
    ...utilitiesTools,
  • src/server.ts:29-35 (registration)
    Dynamically registers all tools from allTools, including validate_zip, for MCP ListTools requests with conditional description.
    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),
    }));
Behavior2/5

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

With no annotations provided, the description carries full burden for behavioral disclosure. It mentions QIT CLI dependency and installation methods, which is useful context about prerequisites. However, it doesn't describe what validation entails (e.g., checks performed, success/failure criteria, output format), making it incomplete for a validation tool.

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

Conciseness2/5

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

The description is poorly structured - it starts with the tool's purpose but immediately devotes most content to installation instructions and error messages. The warning about QIT CLI not being detected is front-loaded but doesn't belong in the core description, making it inefficient and cluttered.

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

Completeness2/5

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

For a validation tool with no annotations and no output schema, the description is incomplete. It doesn't explain what validation means in this context, what criteria are checked, or what the tool returns. The QIT CLI dependency information is helpful but doesn't compensate for the missing functional context.

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?

The input schema has 100% description coverage, with the 'path' parameter clearly documented. The description doesn't add any parameter-specific information beyond what's in the schema, so it meets the baseline of 3 for high schema coverage.

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

Purpose3/5

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

The description states the tool validates a local plugin or theme ZIP file's content, which is a clear purpose. However, it doesn't distinguish this from sibling tools like 'list_extensions' or 'manage_package', and the description is dominated by installation instructions rather than tool functionality.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives. It mentions QIT CLI requirements but doesn't explain the tool's role in the broader workflow or how it relates to sibling tools like 'run_test' or 'manage_package'.

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/woocommerce/qit-mcp'

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