Onboard a library

Command: /external-lib-flow · ← All scenarios · User guide

Teach the agent how to use an external or private library — without giving it source access during later work — by packaging the library into compact reference material plus a short learning guide.

Use this when your project depends on an internal SDK, shared library, or external client, and you want the agent to understand its API and structure for future tasks.

Not for: modernizing or rewriting the library (Modernize) — this is usage-understanding only.

Running it

/external-lib-flow Teach AI about our internal authentication library at ../vendor/auth-sdk
/external-lib-flow Onboard the shared utilities package at ./libs/reporting-engine

The only thing it needs from you is the project path.

How it works

It’s a short, mostly hands-off routine: point it at the library, it detects the basics, packages the codebase into a compressed reference file (uses repomix), publishes a brief onboarding guide, and verifies the agent can find it later.

flowchart TB
    Start(["/external-lib-flow + path"]) --> Discover["Detect name, version, stack <br>(asks for the path)"]
    Discover --> Analyze["Package codebase (compressed) <br>+ extract entry points"]
    Analyze --> Publish["Publish reference + onboarding doc"]
    Publish --> Verify{"Agent can <br>find & search it?"}
    Verify -->|no| Publish
    Verify -->|yes| Done(["Agent can use the library"])

    classDef step fill:#dae8ff,stroke:#3674b5,color:#102a43;
    classDef gate fill:#fff2cc,stroke:#b58b00,color:#493800;
    classDef done fill:#e5f7e8,stroke:#35834a,color:#153b20;
    class Discover,Analyze,Publish step;
    class Verify gate;
    class Start,Done done;

The library is packaged into a compressed XML file (built for the agent to grep, not for humans to read), and a short learning guide tells the agent how to look things up. An architecture rule is added so future sessions know to consult the reference instead of guessing.

What you’ll be asked to do

Provide (or confirm) the library path — that’s the single required question — and confirm the detected metadata if prompted.

What it creates

In refsrc/: <project-name>.xml (the compressed codebase) and <project-name>-onboarding.md (the short learning guide). It also adds a rule to docs/ARCHITECTURE.md telling the agent to use these via search, and tracks progress in a state file.

Write or change code then uses the onboarded library · Modernize if you’re migrating onto it.

Prerequisites: repomix (MCP or CLI).

Sources