docs(skill): reconcile skill.md drift + add CI drift guard - #153
Open
iret77 wants to merge 1 commit into
Open
Conversation
… guard The Python bridge copy (python/src/aiui_mcp/skill.md) had drifted from the canonical docs/skill.md and was missing whole sections for capabilities that BOTH bridges expose: the compare tool, the annotated_image form field, and the Image sources (src/thumbnail) resolution rules plus the data:-URL shell-encoding anti-pattern. Port those into the Python copy (worded for the bridge host), and reflect compare in the intro list, tool-choice table, and window-size section. Deliberate per-bridge tailoring (frontmatter, intro wording, terser prose, width/height size overrides) is preserved. Add scripts/check-skill-drift.sh, which compares the field/tool section headers of the two copies and fails if either documents a field/tool the other doesn't (with a small commented allowlist for intentional divergences), wired in as the lightweight skill-drift CI job.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reconciled die über frühere PRs entstandene Drift zwischen den beiden skill.md-Dateien und baut einen CI-Guard ein, damit sie nicht wiederkehrt.
Ausgangslage:
docs/skill.md(kanonisch, viainclude_str!in den nativen Rust-MCP-Server eingebettet) undpython/src/aiui_mcp/skill.md(mitgelieferte Kopie für die Python-Bridgeaiui-mcpauf remote SSH-Hosts) waren auseinandergelaufen — der Python-Kopie fehlten ganze Abschnitte, obwohl die Python-Bridge (verifiziert gegenserver.py) dieselbe Tool-/Feld-Fläche registriert.Geschlossene Lücken (in die Python-Kopie portiert, host-gerecht formuliert):
compare-Tool-Abschnitt + Tool-Choice-Zeile + Fenstergrößen-Hinweisannotated_image-FormularfeldImage sources(src/thumbnail) + Anti-Pattern „shell-encoding data: URLs"Bewusst erhaltenes Per-Bridge-Tailoring: Frontmatter-Description, Intro-Wording („user's machine"), der
upload-Abschnitt (Bridges unterscheiden sich real),width/height-Overrides (per Allowlist).Drift-Guard:
scripts/check-skill-drift.shvergleicht die Feld-/Tool-Abschnitts-Marker beider Dateien und schlägt fehl, wenn eine Datei ein Tool/Feld dokumentiert, das der anderen fehlt (kleine Allowlist für gewollte Abweichungen, im Skript dokumentiert). Als leichterskill-drift-Job inci.ymlverdrahtet.Kein Versions-Bump (bleibt
0.8.3), CHANGELOG[Unreleased]→### Fixed. Nachlauf zum Feature-Batch (#146/#23/#24/#25/#17).Need help on this PR? Tag
@codesmith-botwith what you need. Autofix is disabled.