X5 Protocol Skill for Openclaw

A comprehensive CLI tool for executing, debugging, and generating X5 protocol-compliant API requests and cURL commands.

growingppp
v1.0.0
Apr 1, 2026
0
691
0

Install & Download

1. ClawHub CLI

The fastest way to install a skill directly from the registry.

npx clawhub@latest install x5-protocol

2. Manual Installation

Copy the skill folder to one of these locations

Global
~/.openclaw/skills/
Workspace
<project>/skills/

Priority: Workspace > Local > Bundled

3. Prompt Installation

Copy this prompt to OpenClaw to install it automatically.

Help me install x5-protocol using Clawhub. If Clawhub is not installed, install it first (npm i -g clawhub).

Prefer to download?

Get the raw skill files in a ZIP archive.

What is X5 Protocol Skill?

The X5 Protocol Skill is a specialized developer utility designed to handle the complexities of the X5 communication standard within an AI-native environment. As a key component of Openclaw Skills, it automates the tedious aspects of X5 integration, such as MD5 signature calculation, Base64 envelope encoding, and specific URL-encoded form-data formatting.

This tool allows developers and AI agents to interact with X5 service endpoints seamlessly using a Python-based client. Whether you are working with local .x5 request files or performing inline API calls, the skill ensures that every request follows the strict signature rules: sign = md5(appid + body + appkey). It is an essential asset for teams maintaining legacy or high-security systems that rely on this specific protocol architecture.

X5 Protocol Skill Use Cases

  • Executing X5 API requests directly from the terminal or via an AI agent.
  • Parsing and listing multiple request definitions stored within .x5 files.
  • Generating standard cURL commands for X5 requests to share with teammates or use in scripts.
  • Debugging service endpoints by inspecting the encoded Base64 payload and MD5 signatures without sending the request.
  • Overriding file-based configurations with dynamic CLI parameters for rapid testing.

How X5 Protocol Skill Works

  1. The user provides a .x5 file or inline parameters including appid, appkey, and the target URL.
  2. The skill parses the input, extracting the X5-Method and the JSON body.
  3. It calculates a secure MD5 signature by concatenating the appid, compact JSON body, and appkey.
  4. An X5 envelope is constructed containing the header (appid, sign, method) and the stringified body.
  5. The entire envelope is Base64 encoded and wrapped in a data= URL-encoded POST parameter.
  6. The client sends the request and returns the X5-standardized response, identifying success via HTTP 2xx status and specific X5 return codes.

X5 Protocol Skill Setup

To integrate this tool into your Openclaw Skills workflow, ensure you have Python 3 installed. No external dependencies are required.

# Navigate to your skills directory
cd ~/.claude/skills/x5-protocol

# Test the client with a help command
python3 scripts/x5_client.py --help

X5 Protocol Skill Data Schema & Taxonomy

The skill utilizes a specialized .x5 file format to store request metadata and templates.

Directive Type Purpose
@name String Identifier for specific requests within a multi-request file.
@appid String The application identifier for signature logic.
@appkey String The secret key used for MD5 hashing.
@url URL The destination endpoint for the POST request.
X5-Method Header Defines the specific API action to be executed.

Internal data processing follows a strict JSON envelope structure for both requests and responses to ensure compatibility across Openclaw Skills integrations.

X5 Protocol Skill Advanced Features

  • Multi-request Support: Define and manage multiple API scenarios within a single .x5 file using ### delimiters.
  • Dry-Run Mode: Use the --dry-run flag to validate signature logic and payload structure before hitting production endpoints.
  • CLI Overrides: Dynamically inject or replace app credentials and methods at runtime, bypassing static file definitions.
  • JSON Output Mode: Enable --json for clean, programmatic consumption by other scripts or AI agents.
  • Custom Headers: Support for arbitrary HTTP headers alongside the required X5 protocol headers.

SKILL.md


Loading

Related Openclaw Skills

METADATA

Github Stars: 0
forks: 0

Featured*