Use this checklist before submitting a skill to Agensi. Every item here contributes to passing the security scan, getting approved in quality review, and generating sales once published.
Before publishing, verify your SKILL.md has valid YAML frontmatter with a descriptive trigger-based description, clear step-by-step instructions, no hardcoded secrets, a clean zip structure, and at least one supporting file (reference doc, script, or example). Skills that pass all checklist items get approved faster and sell more.
Your YAML frontmatter is the first thing the agent reads. It determines when your skill activates and how it appears on the marketplace.
Name is clear and descriptive. Use a slug-style name like `code-reviewer` or `pytest-generator`, not `my-skill-v2` or `untitled`. This appears in the marketplace listing and in the agent's skill list.
Description is trigger-based. The description tells the agent when to load the skill. Write it as "Use when the user asks to..." followed by the specific actions that should activate the skill. Include 3 to 5 trigger phrases. For detailed guidance, read
How to Write a SKILL.md Description That Triggers.
Detailed Checklist and Practical Steps
To ensure your SKILL.md file is ready for publishing, follow these steps carefully.
1. Validate YAML Frontmatter
- Use an online YAML validator to check syntax.
- Ensure fields like `name`, `description`, `version`, and `author` are present.
- Use hyphen-separated lowercase names for the skill slug.
Example Valid Frontmatter:
```yaml
---
name: code-reviewer
version: 1.0.0
author: Jane Doe
description:
- Use when the user asks to review code quality.
- Use when the user wants suggestions for code improvement.
---
```
2. Write Clear, Step-by-Step Instructions
- Use numbered lists to break down user or agent instructions.
- Avoid ambiguous language; be specific about input and expected output.
- Include examples where possible.
Example:
1. User provides a code snippet.
2. Agent analyzes code for style and errors.
3. Agent returns improvement suggestions.
3. Avoid Hardcoded Secrets
- Never embed API keys, passwords, or tokens in your SKILL.md or related files.
- Use environment variables or secure vaults where applicable.
- Double-check your files using a text search for common secret patterns.
4. Organize Your Zip File Cleanly
- Place SKILL.md at the root of your zip archive.
- Include supporting files like README.md, example scripts, or reference docs in appropriately named folders.
- Avoid deeply nested folders or unrelated files.
Tip: Use a folder named `examples` for demo scripts and `docs` for reference material.
5. Include Supporting Files
- At least one supporting file is required to enhance skill usability.
- Examples include a sample script, a detailed README, or companion JSON files.
- This helps with agent testing and user understanding.
Use Case: For a data processing skill, include a sample CSV file and a Python script demonstrating usage.
- Test your skill locally or in a staging environment before submission.
- Verify trigger phrases activate the skill as expected.
- Confirm the skill handles both typical and edge case inputs gracefully.
Tip: Create a test plan listing expected inputs and outputs to systematically check behavior.
1.
Code Review Skill:
- Frontmatter name: `code-reviewer`
- Description triggers: "Use when the user asks to review code", "Use when the user wants suggestions for code improvement"
- Supporting files: example Python script, README with usage instructions
- Result: Faster approval, positive marketplace reviews
2.
Email Template Generator:
- Provides customizable email templates based on user prompts
- Includes sample templates and a usage guide
- Avoids hardcoded SMTP credentials by expecting user input at runtime
3.
Data Analysis Helper:
- Triggers when user requests data summaries or visualizations
- Includes example datasets, Jupyter notebooks for demonstration
- Clear step-by-step instructions for running analyses
Tips for Faster Approval and Higher Sales
- Keep descriptions concise but trigger-rich.
- Provide comprehensive examples to reduce user confusion.
- Ensure no security issues by scanning for secrets.
- Follow Agensi’s folder and file naming conventions strictly.
- Update your skill regularly based on user feedback.
Publishing a SKILL.md file is more than just writing markdown; it involves careful planning, organization, and testing. Use this checklist as your go-to guide to ensure your skill gets approved quickly and performs well in the marketplace. A well-prepared SKILL.md with clear frontmatter, instructions, supporting files, and a clean zip structure not only passes security and quality reviews but also delights users, driving sales and positive feedback.