create-package-skill

Scaffolds and validates package-specific SKILL.md files for Azure SDK Java packages.

2.6k|2.2k|Updated Dec 6, 2011
One-click install
npx skills add https://github.com/Azure/azure-sdk-for-java --skill create-package-skill
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: create-package-skill
Source: https://github.com/Azure/azure-sdk-for-java/tree/main/.github/skills/create-package-skill
Command: npx skills add https://github.com/Azure/azure-sdk-for-java --skill create-package-skill

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Service teams maintaining Azure SDK for Java packages need a repeatable way to encode package-specific tribal knowledge (customization patterns, generated vs hand-written code boundaries, regeneration pitfalls) into discoverable agent skills, but writing a well-structured SKILL.md from scratch is error-prone and inconsistent.

Core Features & Use Cases

  • Package Scanning: Detects TypeSpec generation, customization files, generated vs hand-written sources, service versions, and test setup to build a package profile.
  • Guided Scaffolding: Generates a SKILL.md with required sections (Common Pitfalls, Architecture, After Regeneration, Testing) plus architecture.md and customizations.md reference files.
  • Structural Validation: Runs vally lint checks (spec-compliance, valid-refs, orphan-files) and token budget verification before finalizing.
  • Use Case: A Cosmos SDK engineer asks the agent to bootstrap a skill for azure-cosmos; the wizard scans the package, drafts the skill with package-specific pitfalls, validates it, and places it under the package's .github/skills/ directory for automatic discovery.

Quick Start

Ask the agent to create a package skill for your Azure SDK package, for example by saying "create a package skill for sdk/search/azure-search-documents".

Frequently Asked Questions about create-package-skill

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create a SKILL.md for my Azure SDK Java package?▼

Run the create-package-skill wizard and provide your package name or path, such as sdk/search/azure-search-documents. It scans the package, scaffolds a SKILL.md with pitfalls and architecture sections, generates reference files, and validates the result with vally lint.

Where should a package skill be placed in the azure-sdk-for-java repo?▼

Package skills live at sdk/<service>/<package>/.github/skills/<skill-name>/SKILL.md inside the package directory. Placement is registration: the find-package-skill tool discovers skills automatically from that location with no central registry.

What does vally lint check when validating a skill?▼

vally lint runs three checks: spec-compliance (valid frontmatter and name matching the directory name), valid-refs (all markdown links resolve), and orphan-files (no unreferenced files in references/). The most common failure is a name-directory mismatch.

Should package skills document code generation and build steps?▼

No. Generation, build, and test workflows are handled by the generate-sdk-locally shared skill and MCP tools like azsdk_package_generate_code. Package skills should only document package-specific patterns those tools do not know, such as customization behavior and error categorization.

What are the token limits for SKILL.md and reference files?▼

SKILL.md should stay under 500 tokens as a soft limit and under 5000 as a hard limit. Each reference file should stay under 1000 tokens; split content into additional reference files if a file exceeds the budget.