Skip to main content
Glama

sync_cache

Update local cache data from QIT Manager to ensure test environments and results remain current for WordPress/WooCommerce plugin testing.

Instructions

Re-sync local cache with QIT Manager.

⚠️ 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

No arguments

Implementation Reference

  • The handler function for the 'sync_cache' tool. It executes the QIT CLI command 'sync' using executeAndFormat to synchronize the local cache with the QIT Manager.
    handler: async () => {
      const cmdArgs = ["sync"];
      return executeAndFormat(cmdArgs);
    },
  • The Zod input schema for the 'sync_cache' tool, which requires no parameters.
    inputSchema: z.object({}),
  • The complete tool object definition for 'sync_cache' exported as part of utilitiesTools.
    sync_cache: {
      name: "sync_cache",
      description: "Re-sync local cache with QIT Manager.",
      inputSchema: z.object({}),
      handler: async () => {
        const cmdArgs = ["sync"];
        return executeAndFormat(cmdArgs);
      },
    },
  • Registration of utilitiesTools (including sync_cache) into the allTools aggregate export.
    ...utilitiesTools,
  • src/server.ts:29-38 (registration)
    MCP server ListTools handler that registers and exposes all tools from allTools, including sync_cache.
      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 };
    });
Behavior2/5

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

No annotations are provided, so the description carries full burden. While it mentions the tool requires QIT CLI installation, it doesn't describe what the sync actually does behaviorally - what gets updated, whether it's destructive, how long it takes, or what happens on success/failure. The description is more about prerequisites than behavioral traits.

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 leads with the actual purpose in one sentence, then devotes 90% of the content to installation instructions that don't belong in a tool description. The warning about QIT CLI not being detected is particularly problematic as it appears to be runtime diagnostic output rather than descriptive documentation.

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 tool with no annotations, no output schema, and 0 parameters, the description should focus on what the tool does and what it returns. Instead, it's dominated by installation troubleshooting. The actual behavioral context - what 're-sync' means, what gets synchronized, what the expected outcome is - is barely addressed.

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

Parameters4/5

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

With 0 parameters and 100% schema description coverage, the baseline is 4. The description correctly indicates this is a parameterless operation that performs a sync, which aligns with the empty input schema. No additional parameter information is needed or provided.

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 'Re-sync local cache with QIT Manager', which provides a clear verb ('re-sync') and resource ('local cache'), but it doesn't distinguish from sibling tools like 'manage_cache'. The purpose is understandable but lacks specificity about what distinguishes this sync operation from other cache-related operations.

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 like 'manage_cache'. It focuses entirely on installation prerequisites rather than usage context. There's no mention of when this sync is needed or what triggers it.

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