Skip to content

feat(skills): ship a consumer skill with the package - #4

Merged
Upd4ting merged 2 commits into
mainfrom
feat/package-shipped-skill
Jul 20, 2026
Merged

feat(skills): ship a consumer skill with the package#4
Upd4ting merged 2 commits into
mainfrom
feat/package-shipped-skill

Conversation

@Upd4ting

@Upd4ting Upd4ting commented Jul 19, 2026

Copy link
Copy Markdown
Member

Summary

  • Adds skills/<name>-interface/SKILL.md: a lean, source-grounded consumer guide (imports per subpath, minimal example, gotchas, pointer to the shipped .d.ts)
  • Wires it for distribution: antelopeJs.skills: ["./skills"] + skills in the files array
  • Consumers get it automatically: the antelopejs Claude Code plugin syncs package-shipped skills into .claude/skills/; the cms-ai chatbox loads them at runtime
  • Content fact-checked against src//docs/ by an adversarial review pass (imports validated against the exports map, examples verified against real signatures)

Test plan

N/A (documentation artifact; frontmatter and import paths validated mechanically)

Greptile Summary

This PR ships a consumer skill guide (skills/mongodb-interface/SKILL.md) alongside the package and wires it for distribution by adding docs and skills to the npm files array and registering the skills directory in antelopeJs.skills.

  • SKILL.md: Documents GetClient(), the internal provider namespace (SetClient/UnsetClient/connected), key gotchas (pending-forever promise, don't cache the client, don't call client.close()), and pointers to docs/1.introduction.md and dist/index.d.ts — all cross-checked against src/index.ts and the existing docs.
  • package.json: Adds "docs" and "skills" to files, and sets "antelopeJs": { "skills": ["./skills"] } so the AntelopeJS Claude Code plugin can sync the skill automatically.

Confidence Score: 5/5

Safe to merge — purely additive documentation and packaging changes with no logic modifications.

Every claim in SKILL.md was verified against src/index.ts and docs/1.introduction.md: exported symbols match, behavioural descriptions are accurate, and the docs/dist references are now valid because both directories are added to the npm files array in the same commit. No existing behaviour is altered.

No files require special attention.

Important Files Changed

Filename Overview
package.json Adds docs and skills to the npm files array and registers ./skills in the antelopeJs skills manifest — both changes are consistent with distributing the new SKILL.md and making docs reachable from the referenced skill path.
skills/mongodb-interface/SKILL.md New consumer skill document; all imports, exported symbols (GetClient, internal.SetClient, internal.UnsetClient, internal.connected), behavioural gotchas, and the docs reference verified against src/index.ts and docs/1.introduction.md.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A["npm publish<br/>(@antelopejs/interface-mongodb)"] --> B["Package contents<br/>dist/ + docs/ + skills/"]
    B --> C["AntelopeJS Claude Code plugin<br/>(syncs package skills)"]
    B --> D["cms-ai chatbox<br/>(loads skills at runtime)"]
    C --> E[".claude/skills/mongodb-interface/SKILL.md"]
    D --> F["AI assistant context:<br/>GetClient usage, gotchas, provider lifecycle"]
    E --> F
Loading
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
    A["npm publish<br/>(@antelopejs/interface-mongodb)"] --> B["Package contents<br/>dist/ + docs/ + skills/"]
    B --> C["AntelopeJS Claude Code plugin<br/>(syncs package skills)"]
    B --> D["cms-ai chatbox<br/>(loads skills at runtime)"]
    C --> E[".claude/skills/mongodb-interface/SKILL.md"]
    D --> F["AI assistant context:<br/>GetClient usage, gotchas, provider lifecycle"]
    E --> F
Loading

Reviews (4): Last reviewed commit: "docs(skills): use fictional domains in c..." | Re-trigger Greptile

Add skills/<name>-interface/SKILL.md — a lean, source-grounded guide for
agents consuming this interface (imports, minimal example, gotchas) —
declared via antelopeJs.skills and published through the files array.
Consumers receive it automatically: the antelopejs Claude Code plugin
syncs package-shipped skills into a project's .claude/skills/, and the
cms-ai chatbox loads them at runtime.

Content was fact-checked against src/ and docs/ by an adversarial
review pass (imports validated against the exports map, examples
verified against real signatures).
@Upd4ting

Copy link
Copy Markdown
Member Author

@greptile review

1 similar comment
@Upd4ting

Copy link
Copy Markdown
Member Author

@greptile review

@Upd4ting

Copy link
Copy Markdown
Member Author

@greptile review

@Upd4ting
Upd4ting merged commit ce9a203 into main Jul 20, 2026
2 of 3 checks passed
@Upd4ting
Upd4ting deleted the feat/package-shipped-skill branch July 20, 2026 19:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant