Official plugin catalog for az-scout.
Explore the available plugins in the online catalog: docs.az-scout.com/catalog
Each plugin entry has the following fields:
| Field | Required | Description |
|---|---|---|
name |
Yes | Package name (e.g. az-scout-plugin-batch-sku) |
description |
Yes | One-line description |
source |
Yes | "pypi" or "github" |
url |
If source=github | GitHub URL for direct installation |
repository |
Yes | GitHub repository URL |
authors |
Yes | Array of GitHub usernames of the authors |
tags |
Yes | Array of keyword tags |
audit |
No | Enable automated convention audits (true/false). Defaults to true for az-scout org repos, false for others. |
long_description |
No | Longer description shown below the short one in the catalog UI. |
- Fork this repository
- Add your plugin entry to
catalog.json(alphabetical order) - Open a pull request
The CI will validate the JSON schema and check that repository URLs are accessible.
The catalog includes an automated review workflow that creates review issues on plugin repos and assigns GitHub Copilot to review them against az-scout conventions.
It runs monthly (1st of each month) and can be triggered manually via the Review Plugins workflow.
- Reads
catalog.jsonand filters plugins withaudit: true - For each plugin, creates an issue on the plugin repo with the full review-plugin checklist embedded
- Assigns Copilot to the issue — Copilot reads the codebase and posts its findings as a comment (or opens a PR with fixes)
- Existing open review issues are skipped to avoid duplicates
The review checklist covers:
- Naming conventions (package, module, entry point, slug)
- Packaging and build configuration (hatchling, ruff, mypy)
- Plugin protocol compliance (class structure, lazy imports, no global state)
- Type annotations and MCP tool docstrings
- Frontend conventions (JS/CSS patterns, dark theme, event handling)
- Isolation rules (no global mutation, no route conflicts)
The workflow requires an AUDIT_PAT secret — a fine-grained PAT scoped to
az-scout/* repos with issues: write and contents: read permissions.
Run the workflow from the Actions tab with optional inputs:
- plugin — review a single plugin by package name (leave empty for all)
- dry_run — print what would happen without creating issues
This repository includes Copilot prompt files in .github/prompts/:
add-plugin-to-catalog.prompt.md— guides adding a new plugin to the catalogreview-plugin.prompt.md— full convention review checklist for a plugin
The az-scout Plugin Manager fetches this catalog at startup:
GET https://plugin-catalog.az-scout.com/catalog.json