← Back to Skills Marketplace
Skill Doc Formatter
by
austindixson
· GitHub ↗
· v1.0.0
536
Downloads
0
Stars
0
Active Installs
1
Versions
Install in OpenClaw
/install skill-doc-formatter
Description
Formats SKILL.md (OpenClaw/Cursor skill docs) for optimal display on ClawHub. Produces a consistent structure—Description, Installation, Usage with benefit-f...
Usage Guidance
This package appears to do exactly what it says: format SKILL.md files and run a local static security checklist. It's safe to run locally with these caveats: 1) Prefer running without --inplace first (use stdout or -o) so you can review changes before overwriting; 2) The security checker is heuristic (regex-based) and may report false positives/negatives — treat its output as guidance, not authoritative proof; 3) The source/owner is unknown (no homepage), so if you plan to run this on sensitive repositories, review the scripts yourself (they're bundled and small) before use. If you want stronger assurance, inspect scripts/security_review.py and scripts/format_skill_doc.py in full (they are included) or run them in an isolated environment.
Capability Analysis
Type: OpenClaw Skill
Name: skill-doc-formatter
Version: 1.0.0
This skill bundle is designed for documentation formatting and security review of *other* OpenClaw skills. The `SKILL.md` clearly outlines its purpose, including a detailed 'Security Review' section that describes various checks for common vulnerabilities (e.g., secret logging, undeclared dependencies, unsafe command execution patterns). The Python scripts (`format_skill_doc.py` and `security_review.py`) implement these features. `format_skill_doc.py` performs text processing and calls `security_review.py` via `subprocess.run`, which is a legitimate internal invocation. `security_review.py` scans other skill files for security issues but does not perform any malicious actions itself. There is no evidence of data exfiltration, unauthorized execution, persistence, or prompt injection against the agent. The entire package is geared towards improving skill quality and security, not compromising it.
Capability Assessment
Purpose & Capability
The name/description (format SKILL.md for ClawHub) matches the provided files and behavior. The repo contains a formatter (scripts/format_skill_doc.py), templates, and a security checker (scripts/security_review.py). No unrelated credentials, binaries, or install steps are requested.
Instruction Scope
SKILL.md instructs running the formatter against local SKILL.md files and optionally running the bundled security review. The scripts read files in the supplied skill directory, parse frontmatter and sections, and may write output (with --inplace or -o). The security checker inspects files for patterns (subprocess usage, logging, env vars, missing files) but does not send data off-host or execute third-party code. Note: --inplace will overwrite files, so review output before overwriting.
Install Mechanism
No install specification is present (instruction-only with shipped scripts). The tool is run with Python from source; it does not download archives or execute installers. This is low-risk and proportionate for a formatter utility.
Credentials
The skill declares no required environment variables or credentials. The bundled security checker scans code for uses of env vars and secrets but does not itself require or request credentials.
Persistence & Privilege
No persistent/background behavior is requested (always:false). The skill does not modify other skills or global agent settings; it operates on files you point it at.
How to Use
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install skill-doc-formatter - After installation, invoke the skill by name or use
/skill-doc-formatter - Provide required inputs per the skill's parameter spec and get structured output
Version History
v1.0.0
Initial release of Skill Doc Formatter – a tool to standardize SKILL.md documentation for ClawHub.
- Formats SKILL.md files using a clear, ClawHub-optimized structure: Description, Installation, Usage, Examples, and Commands.
- Supports automatic example generation and section mapping for consistent, benefit-focused documentation.
- Includes a security review tool to highlight common issues before ClawHub publication.
- Provides CLI options for formatting, overwriting, and output control.
- Supplies a manual template and documentation best practices for skill authors.
Metadata
Frequently Asked Questions
What is Skill Doc Formatter?
Formats SKILL.md (OpenClaw/Cursor skill docs) for optimal display on ClawHub. Produces a consistent structure—Description, Installation, Usage with benefit-f... It is an AI Agent Skill for Claude Code / OpenClaw, with 536 downloads so far.
How do I install Skill Doc Formatter?
Run "/install skill-doc-formatter" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is Skill Doc Formatter free?
Yes, Skill Doc Formatter is completely free (open-source). You can download, install and use it at no cost.
Which platforms does Skill Doc Formatter support?
Skill Doc Formatter is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created Skill Doc Formatter?
It is built and maintained by austindixson (@austindixson); the current version is v1.0.0.
More Skills