mirror of
https://github.com/microsoft/BCQuality.git
synced 2026-10-05 06:36:55 +01:00
bca8f478d8
* Simplify standalone AL review skill Rename the host-facing skill to al-code-review, reduce it to a thin Entry adapter, document the architecture, and validate host skill metadata. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: af96bb3d-893a-48a2-8298-c8f4271c162c * Anchor plugin paths at PLUGIN_ROOT and restore the layer-filter caveat The adapter delegated index preparation to Entry's Preparation step, but that step is written for the clone model: it runs `pwsh ./tools/Build-KnowledgeIndex.ps1` from the checkout root. A plugin host's working directory is the user's own project, so the path does not resolve and the index is never built. Because knowledge-index.json is gitignored, a fresh install has none, and READ silently degrades to path-based discovery. The adapter now resolves Entry's repo-relative paths against PLUGIN_ROOT and names the absolute index build; the generator resolves its own root, so it indexes and writes the right tree from any cwd. Entry also asserted that pruning has always happened before it runs, which is false for an installation that ships the whole tree. Entry now scopes that guarantee to consumers that actually prune, and the caveat dropped in the rewrite - that enabled-layers narrows discovery rather than denying access - is restored in the adapter and summarized in the README. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: 0b67b90d-e4b4-4b92-9684-726c72c43b3f --------- Co-authored-by: Jesper Schulz-Wedde <jesper.schulzwedde@microsoft.com> Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: af96bb3d-893a-48a2-8298-c8f4271c162c Copilot-Session: 0b67b90d-e4b4-4b92-9684-726c72c43b3f
60 lines
3.5 KiB
Markdown
60 lines
3.5 KiB
Markdown
# BCQuality global skills
|
|
|
|
This folder contains BCQuality's layer-independent protocol files and the
|
|
host-native adapter used by standalone plugin installations.
|
|
|
|
The protocol files have two kinds:
|
|
|
|
- **The entry-point skill** — the first skill an agent invokes at runtime.
|
|
- **The three meta-skill contracts** — stable references that define what the rest of BCQuality means.
|
|
|
|
## The entry-point skill
|
|
|
|
| File | Role |
|
|
|---|---|
|
|
| [`entry.md`](entry.md) | **ENTRY** — Given a task context, returns a dispatch record naming the action skill(s) to invoke. The agent's first call when pointed at BCQuality. |
|
|
|
|
Routing logic lives in Entry, not in the orchestrator. An agent that knows only "invoke `/skills/entry.md` first" has enough to drive the rest of the repo.
|
|
|
|
## The meta-skill contracts
|
|
|
|
| # | File | Role | Who reads it |
|
|
|---|---|---|---|
|
|
| 1 | [`read.md`](read.md) | **READ** — Schema + Use. How to read a knowledge file: frontmatter fields, section semantics, matching rules, layer precedence, conflict resolution. | Any agent or action skill that consumes knowledge files. |
|
|
| 2 | [`do.md`](do.md) | **DO** — Action Skill contract. The Source → Relevance → Worklist → Action template and the structured output every action skill produces. Includes super-skill composition. | Any agent invoking an action skill; every action-skill author. |
|
|
| 3 | [`write.md`](write.md) | **WRITE** — New Knowledge. Authoring rules for knowledge files. Defers to `read.md` for the schema. | Contributors (human or agent) adding or editing knowledge files. Not used during consumption. |
|
|
|
|
READ and DO are read on demand — typically by the first action skill the agent executes after dispatch. They are not prerequisites for invoking Entry. WRITE is only used when scaffolding new content.
|
|
|
|
## Standalone plugin adapter
|
|
|
|
| Path | Role |
|
|
|---|---|
|
|
| [`al-code-review/SKILL.md`](al-code-review/SKILL.md) | Exposes BCQuality through the standard `SKILL.md` format when this repository is installed as a plugin. |
|
|
|
|
The adapter is deliberately thin. It translates the caller's request into an
|
|
Entry task context, then follows Entry's dispatch without owning routing,
|
|
review, index, or output policy. It is not an action skill, is not considered
|
|
by Entry, and should not accumulate behavior already defined by `entry.md`,
|
|
`read.md`, `do.md`, or a layered action skill.
|
|
|
|
This gives the two skill formats distinct roles:
|
|
|
|
- `skills/al-code-review/SKILL.md` is the public host integration surface for a
|
|
standalone plugin installation.
|
|
- `microsoft/skills/review/al-code-review.md` is BCQuality's internal
|
|
Microsoft-layer super-skill for coordinating a broad AL review.
|
|
|
|
The host adapter and internal coordinator deliberately share the
|
|
`al-code-review` name because they represent the same user-facing operation in
|
|
their respective formats. Their locations distinguish their roles. The
|
|
adapter remains distinct from BC-ALAgents' separately installed `al-review`
|
|
skill, avoiding a collision in hosts that use one shared skill inventory. The
|
|
reference from the adapter to Entry, and from a dispatched super-skill to its
|
|
leaf skills, is intentional progressive disclosure. It avoids registering
|
|
every internal BCQuality protocol file as an ambient host skill while allowing
|
|
each review domain to run in an isolated context.
|
|
|
|
These contracts are stable. Changes require a PR approved by both maintainers.
|
|
|
|
For the end-to-end flow — from orchestrator trigger through to findings integration — see [`../agent-consumption.md`](../agent-consumption.md). For the high-level project framing, see [`../README.md`](../README.md).
|