renma 0.15.2 → 0.17.0

package/docs/agent-skills-compatibility.md

@@ -0,0 +1,500 @@
+# Agent Skills Compatibility and Migration
+
+This document defines Renma's target `SKILL.md` format for the breaking 0.16.0
+transition. [Agent Skills](https://agentskills.io/specification) owns the
+portable Skill format. Renma extends it with deterministic governance evidence,
+without defining a competing Skill format.
+
+Compatibility is the portable authoring boundary for Skill entrypoints, not
+Renma's complete repository model. A Renma repository may also contain Context
+Lenses, independently owned Context Assets, references, policies, lifecycle and
+ownership declarations, dependencies, and evidence organized across domains,
+products, teams, or workflows. That flexibility applies to the broader
+repository assets, not to arbitrary Skill roots: canonical Skill entrypoints in
+0.16.0 are discovered only under `skills/**/SKILL.md` and
+`.agents/skills/**/SKILL.md`. A custom scan glob does not make a path such as
+`docs/skills/demo/SKILL.md` a Skill. Renma is not an Agent Skills registry,
+runtime, or live router, and repository knowledge does not need to be embedded
+inside the supported Skill directories.
+
+In this document, “pre-0.16 Renma Skill format” refers to the top-level Renma
+metadata syntax supported before Renma 0.16.0. It is the migration source
+format. The 0.16.0 target uses Agent Skills standard fields plus flat
+`metadata.renma.*` entries.
+
+This rollout follows one operating principle:
+
+```text
+LLM proposes. Renma verifies. Human approves.
+```
+
+## Responsibility Boundary
+
+Keep these surfaces separate:
+
+```text
+Agent Skills name, description, body, and references
+  -> portable and primarily LLM-facing
+
+metadata.renma.*
+  -> structured governance evidence for Renma
+
+Renma
+  -> deterministic validation and migration assistance
+
+Human
+  -> approves semantic changes
+```
+
+The Markdown body remains the primary instruction surface after a Skill has
+been activated. Generic Agent Skills clients may not send arbitrary metadata
+to a model. Renma metadata therefore does not guarantee model compliance and
+must not replace behavior-critical instructions.
+
+Use your platform's standard Skill authoring guidance for the name, trigger
+description, instructions, workflow, constraints, examples, and completion
+criteria. Use Renma for repository-specific governance and validation. The
+[Authoring Guide](authoring-guide.md) owns the general new-Skill and
+existing-Skill workflows; this document owns the canonical format and migration
+contract.
+
+## Canonical 0.16.0 Frontmatter
+
+Agent Skills owns the standard top-level fields:
+
+- `name`
+- `description`
+- `license`
+- `compatibility`
+- `metadata`
+- `allowed-tools`
+
+Renma owns flat metadata keys beginning with `renma.`. Agent Skills metadata
+values are strings, including values that encode lists or booleans:
+
+```yaml
+---
+name: spec-review
+description: Review specifications before implementation. Use for ambiguity and boundary analysis.
+metadata:
+  renma.id: skill.testing.spec-review
+  renma.owner: qa-platform
+  renma.status: stable
+  renma.tags: '["testing","spec-review"]'
+---
+```
+
+Do not use unprefixed shared keys such as `metadata.owner`. Do not use a nested
+`metadata.renma` mapping. Unknown `renma.*` keys and other vendors' string
+metadata remain valid metadata and are preserved during migration without
+interpretation.
+
+## Operational Renma Metadata
+
+Renma 0.16.0 makes these governance keys operational for specification-valid
+Agent Skills:
+
+```text
+renma.id
+renma.title
+renma.version
+renma.owner
+renma.status
+renma.purpose
+renma.last-reviewed-at
+renma.review-cycle
+renma.expires-at
+renma.tags
+renma.when-to-use
+renma.when-not-to-use
+renma.requires-context
+renma.optional-context
+renma.requires-lens
+renma.optional-lens
+renma.conflicts
+renma.superseded-by
+```
+
+Renma normalizes these values into the existing asset metadata model used by
+scan findings, inspect, catalog, ownership, graph and dependency resolution,
+readiness, BOM, Trust Graph, diff, and CI reporting. This is a serialization
+change, not a second governance model or a change to those consumers'
+semantics.
+
+Text values are trimmed strings, and `renma.status` retains the existing
+`experimental`, `stable`, `deprecated`, and `archived` lifecycle values. List
+values are JSON-array strings containing strings only:
+
+```yaml
+metadata:
+  renma.tags: '["testing","spec-review"]'
+  renma.requires-context: '["context.testing.boundaries"]'
+  renma.optional-context: '[]'
+```
+
+Canonical list metadata is not comma-separated. Malformed JSON, non-array
+JSON, and non-string array members are invalid rather than guessed. Diagnostics
+for canonical values retain evidence for the specific child key under
+`metadata`, not just the parent mapping.
+
+Empty text, invalid status, and invalid lifecycle or freshness values retain
+their existing operational diagnostic semantics and stable finding IDs where
+applicable.
+
+Operational source selection is explicit:
+
+```text
+specification-valid Agent Skill
+  -> governance and security metadata comes only from metadata.renma.*
+
+invalid, hybrid, or pre-0.16 Skill
+  -> no operational Skill metadata; suggest-metadata may use it as migration input
+
+non-Skill asset
+  -> existing top-level Renma metadata syntax
+```
+
+An Agent Skill must pass the Agent Skills specification checks before any Renma
+metadata becomes operational. Renma authoring warnings do not block operational
+metadata. A Skill never falls back to or merges top-level pre-0.16 equivalents.
+Contexts, context lenses, profiles, references, examples, agents,
+configuration files, and other non-Skill assets keep their existing metadata
+syntax and behavior.
+
+These security keys are also operational under `metadata`:
+
+```text
+renma.allowed-data
+renma.network-allowed
+renma.external-upload-allowed
+renma.secrets-allowed
+renma.requires-human-approval
+renma.forbidden-inputs
+renma.approved-network-destinations
+renma.approved-upload-destinations
+renma.security-profile
+```
+
+Boolean values must be the exact strings `"true"` or `"false"`. List values
+must be JSON-array strings containing strings only. Renma does not coerce YAML
+booleans, alternate boolean spellings, comma-separated lists, or non-string
+array members. Canonical child-key evidence is preserved for diagnostics,
+including multiline YAML values.
+
+## Entrypoint Paths
+
+Canonical Agent Skills entrypoints use the exact filename:
+
+```text
+skills/**/SKILL.md
+.agents/skills/**/SKILL.md
+```
+
+Renma continues discovering historical `skill.md` and `*.skill.md` spellings
+under those roots so `scan` can report validation and migration diagnostics.
+Discovery does not make those spellings Agent Skills-compatible.
+
+The entrypoint migration is explicit:
+
+```text
+skills/demo/skill.md
+  -> skills/demo/SKILL.md
+
+skills/testing/spec-review.skill.md
+  -> skills/testing/spec-review/SKILL.md
+```
+
+The same mappings apply under `.agents/skills/**`. A lowercase `skill.md`
+requires a rename. A flat `*.skill.md` requires a move into the filename-derived
+directory plus a rename. Structured `suggest-metadata` output reports
+`sourcePath`, `targetPath`, and `entrypointMigration` (`none`, `rename`, or
+`move-and-rename`) so the path change cannot be mistaken for an apply-ready
+frontmatter-only result.
+
+Repository discovery recognizes these roots only at the beginning of a
+repository-relative path. A nested path such as `docs/skills/demo/SKILL.md` is
+not a repository Skill, and a later `skills` segment cannot escape a reserved
+`references` or `examples` directory. For absolute `suggest-metadata` targets,
+Renma requires one unambiguous Skill root and rejects paths with multiple
+possible roots.
+
+Repository-relative classification normalizes leading and internal `.` segments
+and safe `..` segments before checking the root. A path is rejected if `..`
+escapes its original `skills/` or `.agents/skills/` root, even if a later segment
+would appear to re-enter it. User-facing structured command argv retains the
+exact path discovered by `scan` or supplied by the user.
+
+Inside an Agent Skill directory, `assets/`, `scripts/`, and `references/`
+contain Skill-local support material and are not treated as nested Skill roots.
+Renma also reserves its existing `examples/` and `profiles/` support
+directories. The same reserved names cannot be used as top-level Skill names
+under `skills/` or `.agents/skills/` without reserved-name guidance.
+
+## Validation During Scan
+
+Agent Skills validation is part of the existing scan workflow:
+
+```bash
+renma scan .
+renma scan . --format json
+```
+
+The JSON report includes a dedicated `agentSkills` summary and per-Skill
+results. Text output includes a concise valid/invalid summary, structural issues,
+authoring warnings, and a `suggest-metadata` migration command when pre-0.16
+Renma Skill fields or a historical entrypoint spelling are present.
+
+In JSON, `migrationCommand` contains structured `command` and `args` fields plus
+a display string. The argv fields preserve the exact path and are the source of
+truth for tools. Text output uses POSIX shell quoting when a path contains
+spaces or shell metacharacters.
+
+The locally versioned validation profile uses the maintained `yaml` package in
+YAML 1.2 mode. It validates:
+
+- the exact `SKILL.md` filename;
+- frontmatter presence and closure;
+- YAML syntax and mapping shape;
+- duplicate top-level and `metadata` keys;
+- the allowed Agent Skills top-level fields;
+- required, non-empty string `name` and `description` values;
+- NFKC-normalized name length, Unicode letters/digits, lowercase and hyphen
+  rules, and normalized immediate-parent match. The YAML field is trimmed, but
+  the filesystem directory name is not; leading or trailing directory
+  whitespace is invalid rather than normalized away;
+- description and compatibility length limits;
+- optional field types;
+- `metadata` as a string-to-string mapping.
+
+The validation profile is local. Renma does not fetch a schema or validation
+rules at runtime.
+
+Agent Skills validation does not add a separate validation command or change
+the existing `scan` or `--fail-on` exit contract. Agent Skills results are
+visible in scan output but are not inserted into the existing finding threshold
+path.
+
+## Format Classification
+
+Each inspected Skill receives one migration-oriented classification:
+
+```text
+agent-skills
+  Agent Skills identity with no pre-0.16 Renma Skill fields
+
+renma-legacy
+  pre-0.16 Renma Skill fields without Agent Skills identity
+
+hybrid
+  Agent Skills identity plus pre-0.16 Renma Skill fields
+
+unknown
+  neither Agent Skills identity nor a recognized migration source
+```
+
+Classification remains migration-oriented. Operational normalization is
+stricter: only a specification-valid `agent-skills` document contributes Skill
+metadata. `renma-legacy`, `hybrid`, `unknown`, and otherwise invalid documents
+remain visible to validation and migration diagnostics but contribute no
+operational Skill metadata.
+
+## Selection Boundaries and Execution Constraints
+
+A selection boundary determines whether a Skill should be chosen. If the body
+says `Do not use this skill for test execution`, that exclusion belongs in
+`description` because name and description are the discovery surface.
+
+An execution constraint applies after activation. Instructions such as `Do not
+modify production files` or `Never upload secrets` belong in the body under a
+prominent heading such as `Hard Constraints`, `Prohibited Actions`, or `Safety
+Constraints`. A generic execution constraint must not be copied automatically
+into `description` or `metadata.renma.when-not-to-use`.
+
+Renma may report conservative authoring warnings for a missing usage boundary,
+an omitted selection exclusion, a buried or scattered execution constraint, or
+a prohibition without a supported alternative or stop behavior. Nested
+subsections under a prominent constraint heading remain prominent. These
+warnings do not make a structurally valid Agent Skill invalid.
+
+Agent Skills body inspection and migration description extraction ignore fenced
+examples opened with at least three backticks or at least three tildes. A fence
+closes only with the same character and a marker at least as long as its opener.
+Fence inspection starts at the Markdown body; fence-like text inside YAML block
+scalars does not hide body diagnostics.
+
+## Agent Skills Diagnostic Identifiers
+
+Agent Skills diagnostics use stable identifiers in the `agentSkills` portion of
+scan output. `AS-SKILL-*` identifiers are specification errors and make the
+Skill invalid. `RN-SKILL-*` identifiers are Renma authoring warnings and do not
+affect structural validity or the existing `--fail-on` threshold.
+
+### Specification errors
+
+| Identifier | Meaning |
+| --- | --- |
+| `AS-SKILL-NONCANONICAL-FILENAME` | The entrypoint filename is not exactly `SKILL.md`. |
+| `AS-SKILL-MISSING-FRONTMATTER` | YAML frontmatter is absent. |
+| `AS-SKILL-UNCLOSED-FRONTMATTER` | The opening frontmatter delimiter has no closing delimiter. |
+| `AS-SKILL-INVALID-YAML` | The frontmatter is not valid YAML. |
+| `AS-SKILL-FRONTMATTER-NOT-MAPPING` | The frontmatter root is not a YAML mapping. |
+| `AS-SKILL-DUPLICATE-FIELD` | A top-level frontmatter field is declared more than once. |
+| `AS-SKILL-DUPLICATE-METADATA-KEY` | A key in `metadata` is declared more than once. |
+| `AS-SKILL-UNEXPECTED-TOP-LEVEL-FIELD` | A top-level field is outside the Agent Skills field set. |
+| `AS-SKILL-MISSING-NAME` | The required `name` field is absent or empty. |
+| `AS-SKILL-INVALID-NAME` | `name` has the wrong type or violates the name rules. |
+| `AS-SKILL-NAME-DIRECTORY-MISMATCH` | The normalized `name` does not match its immediate parent directory. |
+| `AS-SKILL-MISSING-DESCRIPTION` | The required `description` field is absent or empty. |
+| `AS-SKILL-INVALID-DESCRIPTION` | `description` is not a string. |
+| `AS-SKILL-DESCRIPTION-TOO-LONG` | `description` exceeds 1,024 Unicode code points. |
+| `AS-SKILL-INVALID-COMPATIBILITY` | `compatibility` is not a non-empty string. |
+| `AS-SKILL-COMPATIBILITY-TOO-LONG` | `compatibility` exceeds 500 Unicode code points. |
+| `AS-SKILL-INVALID-LICENSE` | `license` is present but is not a string. |
+| `AS-SKILL-INVALID-ALLOWED-TOOLS` | `allowed-tools` is present but is not a string. |
+| `AS-SKILL-INVALID-METADATA` | `metadata` is not a string-to-string mapping. |
+
+### Renma authoring warnings
+
+| Identifier | Meaning |
+| --- | --- |
+| `RN-SKILL-DESCRIPTION-MISSING-USAGE-BOUNDARY` | The description does not state when the Skill should be used. |
+| `RN-SKILL-DESCRIPTION-OMITS-SELECTION-BOUNDARY` | A body selection exclusion is absent from the description. |
+| `RN-SKILL-EXECUTION-CONSTRAINT-NOT-PROMINENT` | An execution constraint is outside a prominent constraint section. |
+| `RN-SKILL-EXECUTION-CONSTRAINT-SCATTERED` | Execution constraints are scattered across sections. |
+| `RN-SKILL-EXECUTION-CONSTRAINT-MISSING-ALTERNATIVE` | A prohibition has no nearby supported alternative or stop behavior. |
+
+## One-Way Migration
+
+Pre-0.16 Renma Skill fields are migration input only:
+
+```text
+pre-0.16 Renma Skill
+  -> Agent Skills identity
+  -> metadata.renma.*
+```
+
+Use the existing non-editing command with canonical or non-canonical
+entrypoints:
+
+```bash
+renma scan . --fail-on high
+renma suggest-metadata skills/example/SKILL.md --format prompt
+renma suggest-metadata skills/example/skill.md --format json
+renma suggest-metadata skills/testing/spec-review.skill.md --format prompt
+# apply only an unblocked canonical frontmatter candidate
+renma scan . --fail-on high
+```
+
+For Skill targets, `suggest-metadata` can preserve valid standard Agent Skills
+fields, use a valid immediate parent directory as `name`, preserve an existing
+valid description, conservatively extract description evidence from the body,
+move recognized pre-0.16 Renma Skill fields to
+`metadata.renma.*`, and render canonical frontmatter for human review. It never
+edits the file and never proposes a reverse conversion for a canonical Agent
+Skill.
+
+Pre-0.16 security fields migrate in the same one-way proposal. Safe string
+values are preserved, boolean values serialize as exact `"true"` or `"false"`
+strings, and list values serialize as JSON-array strings. Unsafe or ambiguous
+values block canonical frontmatter generation for human review.
+
+Before presenting a non-canonical entrypoint migration, Renma renders the candidate
+frontmatter, combines it with the unchanged Markdown body at the target
+`SKILL.md` path, and runs the existing Agent Skills validator on that in-memory
+result. Any specification error blocks the proposal. If the target entrypoint
+already exists as a distinct filesystem entry, migration is also blocked; Renma
+does not propose overwriting, merging, or deleting either file. Case-only
+renames that resolve to the same filesystem entry are not treated as a
+collision.
+
+For a specification-valid canonical `SKILL.md`, an explicit `--owner <owner>` instead
+produces a canonical metadata retrofit candidate at `metadata.renma.owner`. An
+identical existing owner is preserved without a rewrite. A different existing
+owner blocks the proposal for human review. Without `--owner`, Renma does not
+invent owner metadata or emit a meaningless canonical rewrite. This retrofit is
+not reverse migration.
+
+After generating a suggestion, review the Skill's trigger description,
+instructions, workflow, constraints, and completion criteria using
+platform-native authoring guidance. Review the candidate, apply only intended
+metadata or migration changes, run `renma scan . --fail-on high`, fix relevant
+diagnostics, and rerun validation before human approval.
+
+## Pre-0.16 Value Serialization
+
+Migration never converts native YAML numbers into text. Native YAML booleans
+are accepted only for recognized boolean security fields, where the meaning is
+unambiguous.
+
+- Text scalar fields (`id`, `title`, `version`, `owner`, `status`, `purpose`,
+  `last_reviewed_at`, `review_cycle`, `expires_at`, and `security_profile`)
+  require YAML strings.
+- String-list fields accept YAML arrays containing strings only, pre-0.16
+  comma-separated strings, or JSON-array strings containing strings only.
+  Numeric and boolean elements are blocked.
+- Boolean security fields accept YAML booleans or the exact strings `"true"`
+  and `"false"`, then serialize to exact canonical strings.
+
+For example, `version: "1.0"` and `tags: ["1.0"]` are safe. `version: 1.0`
+and `tags: [1.0]` block canonical frontmatter generation. Likewise,
+`network_allowed: yes` is blocked rather than guessed.
+
+## Unsafe Migration Blocking
+
+Renma does not render canonical frontmatter when migration would be ambiguous
+or lossy. Blocking cases include:
+
+- invalid or unclosed YAML frontmatter;
+- a non-mapping frontmatter document;
+- duplicate top-level or metadata keys;
+- non-string metadata values;
+- an invalid Skill directory name or conflicting identity;
+- conflicting Agent Skills and pre-0.16 Renma Skill values;
+- an unknown top-level field;
+- missing evidence for a usable description;
+- duplicate semantic list values or unsupported pre-0.16 value shapes;
+- a candidate that remains invalid at its target `SKILL.md` path;
+- an existing distinct target entrypoint or an unverifiable target collision;
+
+Renma reports structured blocked evidence with the field and reason. It never
+selects the last duplicate value, silently deletes an unknown field, or assigns
+an unknown top-level field to a vendor namespace.
+
+When blocked, do not apply a candidate. Review the conflict or invalid evidence,
+confirm the Skill's intent using platform-native authoring guidance, correct
+the source evidence, and rerun `suggest-metadata`. After intended corrections,
+run `renma scan . --fail-on high`, fix relevant diagnostics, and rerun the scan.
+
+Within a valid `metadata` mapping, Renma distinguishes:
+
+```text
+known renma.* key
+  interpret for migration comparison and preserve
+
+unknown renma.* key
+  preserve without interpretation
+
+other vendor metadata
+  preserve without interpretation
+
+unknown top-level field
+  block migration
+```
+
+## Renma 0.16+ Boundary
+
+Renma 0.16.0 completes the repository format migration:
+
+- Skills must be specification-valid Agent Skills to contribute operational
+  metadata;
+- all Renma Skill governance and security metadata is read from flat
+  `metadata.renma.*` string entries;
+- pre-0.16 top-level Skill metadata is migration input only;
+- `suggest-metadata` converts recognized governance and security fields in one
+  reviewed proposal;
+- the repository-owned `release-prep` Skill and generated Skill scaffolds are
+  fully canonical;
+- non-Skill assets retain their existing top-level metadata behavior.
+
+This boundary does not add runtime Skill selection, prompt assembly, context
+injection, execution, or telemetry.