Skip to content

Research: External API documentation layer for agent spawns #355

Closed

Description

@CarlosSardo

Problem

Squad agents rely on training data when writing code against external libraries and APIs. This can bring hallucinated API shapes, outdated SDK patterns, and incorrect usage. The skill system (.squad/skills/) handles internal project knowledge well, but there's no mechanism for agents to access current, versioned external documentation at work time.

Idea

Add an external documentation layer that complements Squad skills. Two options worth evaluating:

Option A — Integrate context-hub (chub): A community-curated, versioned doc CDN for AI agents. Provides curated API docs in markdown, language variants, incremental fetch, persistent local annotations (cross-session memory), and a feedback loop to maintainers. Already ships a SKILL.md that teaches agents to search/fetch/annotate.

Option B — Build a native Squad equivalent: A .squad/docs/ or skill extension that lets agents fetch, cache, and annotate external API docs. Could leverage the plugin marketplace for distribution and tie into the existing confidence lifecycle.

Why This Matters

Layer What it covers Exists today?
Skills (.squad/skills/) Internal project patterns & conventions Yes
History (history.md) Per-agent learnings (siloed) Yes
Decisions (decisions.md) Team-level architectural choices Yes
External API docs Current SDK/library documentation No

The gap is the last row. Agents working with any external library are guessing from training data instead of reading current docs.

Research Questions

  1. Delivery mechanism — Should the coordinator auto-detect dependencies (from package.json, .csproj, etc.) and inject docs into spawn prompts, or should agents self-serve via a skill?
  2. Context budget — Full API docs can be large. How does this interact with cheaper models that already receive charter + history + decisions?
  3. Annotation as shared memory — Persistent notes about external APIs (gotchas, workarounds) don't fit neatly into history.md (per-agent) or decisions.md (project decisions). Should this become a new knowledge tier?
  4. Distribution — If built natively, the plugin marketplace is a natural fit. If wrapping context-hub, a bundled skill during squad init would be the lightest integration.

Minimal Version

Regardless of build-vs-integrate:

  1. A skill that teaches agents to fetch external docs before writing code against unfamiliar APIs
  2. A convention for persisting API-specific notes across sessions and agents
  3. Spawn template guidance: "If the task involves an external library, check for available docs before writing code"

References

Activity

  1. github-actions commented on Mar 13, 2026

    @github-actions
    Contributor

    🏗️ Squad Triage — Flight (Lead)

    Issue: #355 — Research: External API documentation layer for agent spawns
    Assigned to: FIDO (Quality Owner)
    Reason: Issue relates to testing/quality work

    @copilot evaluation: 🔴 Not suitable — issue involves work outside the coding agent's capability profile.

    Team roster:

    • Flight (Lead) → label: squad:flight
    • Procedures (Prompt Engineer) → label: squad:procedures
    • EECOM (Core Dev) → label: squad:eecom
    • FIDO (Quality Owner) → label: squad:fido
    • PAO (DevRel) → label: squad:pao
    • CAPCOM (SDK Expert) → label: squad:capcom
    • CONTROL (TypeScript Engineer) → label: squad:control
    • Surgeon (Release Manager) → label: squad:surgeon
    • Booster (CI/CD Engineer) → label: squad:booster
    • GNC (Node.js Runtime) → label: squad:gnc
    • Network (Distribution) → label: squad:network
    • RETRO (Security) → label: squad:retro
    • INCO (CLI UX & Visual Design) → label: squad:inco
    • GUIDO (VS Code Extension) → label: squad:guido
    • Telemetry (Aspire & Observability) → label: squad:telemetry
    • VOX (REPL & Interactive Shell) → label: squad:vox
    • DSKY (TUI Engineer) → label: squad:dsky
    • Sims (E2E Test Engineer) → label: squad:sims
    • Handbook (SDK Usability) → label: squad:handbook
    • Ralph (Work Monitor) → label: squad:ralph
    • @copilot (Coding Agent) → label: squad:copilot

    To reassign, remove the current squad:* label and add the correct one.

  2. bradygaster commented on Mar 13, 2026

    @bradygaster
    Collaborator

    📌 Brady requested this issue be assigned to @diberry (docs/UX triage). Pending collaborator invite to complete assignment.

  3. github-actions commented on Mar 13, 2026

    @github-actions
    Contributor

    📋 Assigned to Procedures (Prompt Engineer)

    Issue: #355 — Research: External API documentation layer for agent spawns

    Procedures will pick this up in the next Copilot session.

    For Copilot coding agent: If enabled, this issue will be worked automatically.
    Otherwise, start a Copilot session and say:
    Procedures, work on issue #355

  4. github-actions commented on Mar 13, 2026

    @github-actions
    Contributor

    📋 Assigned to Flight (Lead)

    Issue: #355 — Research: External API documentation layer for agent spawns

    Flight will pick this up in the next Copilot session.

    For Copilot coding agent: If enabled, this issue will be worked automatically.
    Otherwise, start a Copilot session and say:
    Flight, work on issue #355

  5. deleted a comment from github-actions on Mar 18, 2026
  6. deleted a comment from github-actions on Mar 18, 2026
  7. bradygaster commented on Mar 22, 2026

    @bradygaster
    Collaborator

    Flagging this for follow-up. Brady wants to explore whether Carlos has input on the external API docs layer approach.

    Key question: how should agents access external API documentation at spawn time? Current thinking:

    • Skills handle internal project knowledge well
    • External APIs (Azure SDKs, npm packages, etc.) need a discovery mechanism
    • Could integrate with MCP servers that serve API docs
    • Could use a .squad/apis/ directory with curated doc snippets

    If we don't have enough signal yet, this stays as a research spike. Carlos — any thoughts on how you've handled this?

  8. added
    next-upPriority queue — next issues to work
    and removed
    next-upPriority queue — next issues to work
    on Mar 22, 2026
  9. bradygaster commented on Mar 24, 2026

    @bradygaster
    Collaborator

    Closing — this research spike hasn't had traction and the external API docs problem is better solved ad-hoc per agent skill than as a generic layer. Will revisit if a concrete use case surfaces.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    go:needs-researchNeeds investigationpriority:p2Next sprintsquadSquad triage inbox — Lead will assign to a membertype:spikeResearch/investigation — produces a plan, not code

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions