Repository navigation
docs(plugins): say which spawn paths inject plugin context - #2327
Conversation
features/plugins.md said every spawned agent gets a Plugin Context section built from .squad/plugins/runtime.json. Only the SDK's AgentLifecycleManager.spawnAgent() does that; the coordinator in the hosts, the interactive shell, squad watch, squad loop and the other SDK spawn helpers never read plugin state. Correct plugins.md (with a table of spawn paths and a workaround), plugin-security.md, building-extensions.md and the MemPalace sample README. Closes github#2326
🛫 PR Readiness Check
PR Scope: 🔧 Infrastructure
|
| Status | Check | Details |
|---|---|---|
| ❌ | Single commit | 2 commits — consider squashing before review |
| ✅ | Not in draft | Ready for review |
| ✅ | Branch up to date | Up to date with dev |
| ❌ | Copilot review | No Copilot review yet — it may still be processing |
| ✅ | Changeset present | No source files changed — changeset not required |
| ✅ | Scope clean | No .squad/ or docs/proposals/ files |
| ✅ | No merge conflicts | No merge conflicts |
| ✅ | Copilot threads resolved | No Copilot review threads |
| ❌ | CI passing | 13 check(s) still running |
Files Changed (4 files, +23 −8)
| File | +/− |
|---|---|
docs/src/content/docs/features/plugins.md |
+19 −6 |
docs/src/content/docs/guide/building-extensions.md |
+1 −1 |
docs/src/content/docs/reference/plugin-security.md |
+1 −1 |
samples/plugin-memory-mempalace/README.md |
+2 −0 |
Total: +23 −8
This check runs automatically on every push. Fix any ❌ items and push again.
See CONTRIBUTING.md and PR Requirements for details.
🟡 Impact Analysis — PR #2327Risk tier: 🟡 MEDIUM 📊 Summary
🎯 Risk Factors
📦 Modules Affecteddocs (3 files)
root (1 file)
This report is generated automatically for every PR. See #733 for details. |
|
Thanks Jose! Confirmed in packages/squad-sdk/src/agents/lifecycle.ts:283 that AgentLifecycleManager.spawnAgent() is currently the only path calling �uildActivePluginContext, so documenting the actual spawn path behavior and the charter/skill reference workaround is much clearer for users today. The merge-tree is clean against dev and I approved the CI runs. We are in a release freeze for 2.0.0-preview.2 and will merge this right after the release ships. |
What
Docs only. The plugin docs now say which spawn paths inject plugin context. Today that's only the SDK's
AgentLifecycleManager.spawnAgent(). The docs also say what users get on the other paths and how to point agents at installed plugin files.Why
Closes #2326
features/plugins.mdsaid every spawned agent gets aPlugin Contextsection built from.squad/plugins/runtime.json. OnlyAgentLifecycleManager.spawnAgent()callsbuildActivePluginContext(agents/lifecycle.ts:283), and nothing in the shipped CLI creates one. The coordinator in the hosts, the interactive shell,squad watch,squad loopand the other SDK spawn helpers never read plugin state.How
features/plugins.md:AgentLifecycleManager, other SDK helpers, the coordinator in the hosts, the interactive shell,squad watch,squad loop), each with whether it injects. It also gets a workaround: name the file in your request, or reference it from a charter or skill.Plugin Contextsection specifically.reference/plugin-security.md:9: provider summaries are added only on spawn paths that inject plugin context.guide/building-extensions.md:157: plugin authors check installation withsquad plugin list --jsonand point an agent at a file to test behavior, since a normal session won't load it.samples/plugin-memory-mempalace/README.md: a short paragraph on what installing the sample actually does.I wrote "the Squad interactive shell (
squadwith no arguments)" rather thansquad shell, because there's noshellsubcommand; baresquadopens it.Not in this PR: making real host spawns see enabled plugins, for example a small digest file the spawn template points agents at. That's a design decision, so it's only mentioned in the issue.
PR Readiness Checklist
Branch & Commit
dev(notmain)dev(9d7dff8)Build & Test
markdownlint-cli2andcspellpass on the changed docs pagesDocs
Breaking Changes
None.
Waivers
None.