← Back to Skills Marketplace
README Grader
by
Xudong Guo
· GitHub ↗
· v1.0.0
· MIT-0
101
Downloads
0
Stars
0
Active Installs
1
Versions
Install in OpenClaw
/install readme-grader
Description
Evaluate a README file text, score it out of 100, and provide specific, actionable improvement suggestions.
Usage Guidance
This skill appears coherent and low-risk, but remember it requires you to paste the raw README text into the chat — do not paste secrets, private keys, or proprietary code you cannot share. If your README contains sensitive info, sanitize it before use. Also note the skill requests responses in Chinese and prohibits fetching external URLs, so provide the README content directly. If you need stricter limits, avoid enabling autonomous invocation or remove the skill after the review.
Capability Analysis
Type: OpenClaw Skill
Name: readme-grader
Version: 1.0.0
The 'readme-grader' skill is a well-structured tool designed to evaluate and score README files based on open-source best practices. It contains explicit security guardrails in SKILL.md that instruct the AI agent to treat input as untrusted text and strictly forbids fetching external URLs (e.g., via curl or GitHub API) to mitigate indirect prompt injection risks. No malicious code, data exfiltration, or suspicious execution patterns were found.
Capability Assessment
Purpose & Capability
Name and description (evaluate a README, score, and provide suggestions) match the SKILL.md and included README. There are no unrelated required binaries, env vars, or config paths — everything requested is proportional to the stated purpose.
Instruction Scope
SKILL.md contains explicit, bounded runtime instructions: treat input as text, never execute embedded commands, require the user to paste raw README content, and produce a structured Chinese report. The instructions do not ask the agent to read local files, access external URLs, or access secrets.
Install Mechanism
No install specification and no code files (instruction-only). This minimizes disk writes and remote code fetches. The README contains an example plugin install command but that is documentation only and not an install spec for this bundle.
Credentials
The skill requires no environment variables, credentials, or configuration paths. That is appropriate for a text-analysis README grader which only needs the user-provided README text.
Persistence & Privilege
always is false (default) and disable-model-invocation is false (normal). The skill does not request persistent presence or modify other skills. Autonomous invocation is platform normal and not, by itself, a problem here.
How to Use
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install readme-grader - After installation, invoke the skill by name or use
/readme-grader - Provide required inputs per the skill's parameter spec and get structured output
Version History
v1.0.0
- Initial release of the readme-grader skill.
- Evaluates a provided README file, scoring it out of 100 based on five open-source best-practice criteria.
- Delivers a structured report with score breakdown, strengths, improvement suggestions, and optimized example Markdown.
- Ensures all analysis is done safely as pure text; execution of README instructions or fetching remote files is strictly prohibited.
- Responds in Chinese and encourages users to paste raw README content directly for assessment.
Metadata
Frequently Asked Questions
What is README Grader?
Evaluate a README file text, score it out of 100, and provide specific, actionable improvement suggestions. It is an AI Agent Skill for Claude Code / OpenClaw, with 101 downloads so far.
How do I install README Grader?
Run "/install readme-grader" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is README Grader free?
Yes, README Grader is completely free, licensed under MIT-0. You can download, install and use it at no cost.
Which platforms does README Grader support?
README Grader is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created README Grader?
It is built and maintained by Xudong Guo (@sunny0826); the current version is v1.0.0.
More Skills