Skip to main content
Glama

authenticate

Authenticate with WooCommerce.com Partner Developer account to enable managed testing of WordPress/WooCommerce plugins.

Instructions

Authenticate with WooCommerce.com Partner Developer account. Required before running managed tests.

⚠️ 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
userNoWooCommerce.com username (will prompt if not provided)
application_passwordNoApplication password (will prompt if not provided)

Implementation Reference

  • The main handler function for the 'authenticate' tool. It builds the 'qit connect' command arguments based on input and executes it via executeAndFormat.
    handler: async (args: { user?: string; application_password?: string }) => {
      const cmdArgs = ["connect"];
    
      if (args.user) {
        cmdArgs.push("--user", args.user);
      }
      if (args.application_password) {
        cmdArgs.push("--application_password", args.application_password);
      }
    
      // Add non-interactive flag to avoid prompts that would hang
      cmdArgs.push("--no-interaction");
    
      return executeAndFormat(cmdArgs);
    },
  • Input schema (Zod) for the 'authenticate' tool, defining optional user and application_password fields.
    inputSchema: z.object({
      user: z
        .string()
        .optional()
        .describe("WooCommerce.com username (will prompt if not provided)"),
      application_password: z
        .string()
        .optional()
        .describe("Application password (will prompt if not provided)"),
    }),
  • Spreading authTools (containing 'authenticate') into the central allTools registry, which is used by the MCP server for tool listing and execution.
    ...authTools,
  • src/tools/auth.ts:4-34 (registration)
    Export of authTools object defining the 'authenticate' tool, imported and registered in tools/index.ts.
    export const authTools = {
      authenticate: {
        name: "authenticate",
        description:
          "Authenticate with WooCommerce.com Partner Developer account. Required before running managed tests.",
        inputSchema: z.object({
          user: z
            .string()
            .optional()
            .describe("WooCommerce.com username (will prompt if not provided)"),
          application_password: z
            .string()
            .optional()
            .describe("Application password (will prompt if not provided)"),
        }),
        handler: async (args: { user?: string; application_password?: string }) => {
          const cmdArgs = ["connect"];
    
          if (args.user) {
            cmdArgs.push("--user", args.user);
          }
          if (args.application_password) {
            cmdArgs.push("--application_password", args.application_password);
          }
    
          // Add non-interactive flag to avoid prompts that would hang
          cmdArgs.push("--no-interaction");
    
          return executeAndFormat(cmdArgs);
        },
      },
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It mentions that authentication is required for managed tests and includes installation instructions for QIT CLI, but it does not disclose key behavioral traits such as what happens on successful authentication (e.g., stores credentials, returns a token), error handling, or rate limits. The QIT CLI warnings are context but not core behavioral details.

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 not appropriately sized or front-loaded. The first two sentences are relevant, but the remaining content about QIT CLI installation methods and environment variables is lengthy and not directly about the tool's core functionality. This extraneous information reduces conciseness, as it includes troubleshooting steps that could be better placed elsewhere.

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?

Given the complexity of an authentication tool with no annotations and no output schema, the description is incomplete. It lacks details on behavioral outcomes (e.g., what authentication returns, how errors are handled), does not explain the relationship with sibling tools like 'get_auth_status', and omits information on session management or token usage. The QIT CLI instructions add context but do not compensate for these gaps.

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 clear documentation for 'user' and 'application_password' parameters. The description does not add any meaning beyond what the schema provides regarding parameters, as it focuses on authentication purpose and QIT CLI setup. With high schema coverage, the baseline score of 3 is appropriate, as the schema adequately handles parameter semantics.

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

Purpose4/5

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

The description clearly states the tool's purpose: 'Authenticate with WooCommerce.com Partner Developer account. Required before running managed tests.' It specifies the verb (authenticate) and resource (WooCommerce.com Partner Developer account), and provides context about its necessity for managed tests. However, it does not explicitly differentiate from sibling tools like 'get_auth_status', which might check authentication status rather than perform authentication.

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

Usage Guidelines4/5

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

The description provides clear context for when to use this tool: 'Required before running managed tests.' This implies it should be used as a prerequisite for tools like 'run_test' or 'run_test_group'. However, it does not explicitly state when not to use it (e.g., if already authenticated) or name alternatives, such as using 'get_auth_status' to check authentication status first.

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