mcpField
S
skill-name

skill-name

github.com/resciencelabAgent workflows1.9k1.4k installsUpdated today
Repository

About skill-name

A template for documenting and building an agent skill, with sections for setup, commands, examples, scripts, troubleshooting, and references. It is intended as a starting point rather than a described, ready-to-use skill.

Key features

  1. 01Document prerequisites and setup
  2. 02Add quick-start commands
  3. 03Describe scripts and commands
  4. 04Include usage examples
  5. 05Record troubleshooting and references

Use cases

  1. 01Starting a new skill directory
  2. 02Structuring skill documentation
  3. 03Listing scripts and example workflows

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/resciencelab/opc-skills --skill skill-name

After installing, type/skill-namein Claude Code to confirm it loaded.

Details

From the project README

Skill Name

Brief description of the skill and its purpose.

Prerequisites

List any setup requirements:

  • Environment variables needed
  • API keys required
  • Dependencies (already listed in frontmatter above)

Example setup:

export SKILL_API_KEY="your_api_key"

Quick Start

How to use the skill quickly:

cd <skill_directory>
python3 scripts/command.py --option value

Usage Examples

Example 1: Basic usage
python3 scripts/script.py "input"

Output:

Expected output here
Example 2: Advanced usage
python3 scripts/script.py "input" --flag --option value

Commands

All commands run from the skill directory.

Command 1
python3 scripts/script1.py --help
python3 scripts/script1.py "param1" --option value
Command 2
python3 scripts/script2.py "param1" "param2"

Scripts

  • script1.py - Description of what this script does
  • script2.py - Description of what this script does

API Info

  • Base URL: (if applicable)
  • Rate Limits: (if applicable)
  • Auth: (how authentication works)
  • Docs: Link to official documentation

Troubleshooting

Issue 1

Symptom: Description of the problem

Solution:

  1. Step 1
  2. Step 2
Issue 2

Symptom: Description of the problem

Solution:

  1. Step 1
  2. Step 2

Examples

See examples/ directory for full workflow examples.

References

Notes

  • Important note 1
  • Important note 2

Frontmatter Guide

The YAML frontmatter at the top of this file is required:

FieldTypeRequiredDescription
namestring✓Unique identifier (kebab-case)
descriptionstring✓What the skill does and when to use it. Include trigger keywords and "Use when..." contexts inline.

Creating Your Skill

  1. Copy this template to skills/your-skill-name/
  2. Update the YAML frontmatter
  3. Write your SKILL.md documentation
  4. Add Python/shell scripts in scripts/
  5. Add usage examples in examples/
  6. Update skills.json with your skill entry
  7. Test with your agent before submitting PR

Comments

Markdown supported