@bradygaster/squad-cli 0.8.20 → 0.8.22
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +77 -77
- package/dist/cli/commands/build.d.ts +31 -0
- package/dist/cli/commands/build.d.ts.map +1 -0
- package/dist/cli/commands/build.js +453 -0
- package/dist/cli/commands/build.js.map +1 -0
- package/dist/cli/commands/init-remote.d.ts.map +1 -1
- package/dist/cli/commands/init-remote.js +13 -0
- package/dist/cli/commands/init-remote.js.map +1 -1
- package/dist/cli/commands/link.d.ts.map +1 -1
- package/dist/cli/commands/link.js +13 -0
- package/dist/cli/commands/link.js.map +1 -1
- package/dist/cli/commands/migrate.d.ts +14 -0
- package/dist/cli/commands/migrate.d.ts.map +1 -0
- package/dist/cli/commands/migrate.js +419 -0
- package/dist/cli/commands/migrate.js.map +1 -0
- package/dist/cli/commands/streams.d.ts +15 -0
- package/dist/cli/commands/streams.d.ts.map +1 -0
- package/dist/cli/commands/streams.js +147 -0
- package/dist/cli/commands/streams.js.map +1 -0
- package/dist/cli/core/cast.d.ts.map +1 -1
- package/dist/cli/core/cast.js +111 -63
- package/dist/cli/core/cast.js.map +1 -1
- package/dist/cli/core/init.d.ts +4 -0
- package/dist/cli/core/init.d.ts.map +1 -1
- package/dist/cli/core/init.js +2 -2
- package/dist/cli/core/init.js.map +1 -1
- package/dist/cli/core/team-md.js +34 -34
- package/dist/cli/core/templates.d.ts.map +1 -1
- package/dist/cli/core/templates.js +0 -6
- package/dist/cli/core/templates.js.map +1 -1
- package/dist/cli/core/upgrade.d.ts.map +1 -1
- package/dist/cli/core/upgrade.js +2 -1
- package/dist/cli/core/upgrade.js.map +1 -1
- package/dist/cli/index.d.ts +1 -0
- package/dist/cli/index.d.ts.map +1 -1
- package/dist/cli/index.js +1 -0
- package/dist/cli/index.js.map +1 -1
- package/dist/cli/shell/commands.d.ts +6 -0
- package/dist/cli/shell/commands.d.ts.map +1 -1
- package/dist/cli/shell/commands.js +2 -1
- package/dist/cli/shell/commands.js.map +1 -1
- package/dist/cli/shell/components/AgentPanel.d.ts.map +1 -1
- package/dist/cli/shell/components/AgentPanel.js +4 -3
- package/dist/cli/shell/components/AgentPanel.js.map +1 -1
- package/dist/cli/shell/components/App.d.ts.map +1 -1
- package/dist/cli/shell/components/App.js +36 -2
- package/dist/cli/shell/components/App.js.map +1 -1
- package/dist/cli/shell/components/MessageStream.d.ts.map +1 -1
- package/dist/cli/shell/components/MessageStream.js +2 -1
- package/dist/cli/shell/components/MessageStream.js.map +1 -1
- package/dist/cli/shell/components/ThinkingIndicator.js +2 -2
- package/dist/cli/shell/components/ThinkingIndicator.js.map +1 -1
- package/dist/cli/shell/coordinator.js +88 -88
- package/dist/cli/shell/index.d.ts.map +1 -1
- package/dist/cli/shell/index.js +41 -3
- package/dist/cli/shell/index.js.map +1 -1
- package/dist/cli-entry.js +206 -14
- package/dist/cli-entry.js.map +1 -1
- package/package.json +27 -2
- package/templates/casting-history.json +4 -4
- package/templates/casting-policy.json +35 -35
- package/templates/casting-registry.json +3 -3
- package/templates/ceremonies.md +41 -41
- package/templates/charter.md +53 -53
- package/templates/constraint-tracking.md +38 -38
- package/templates/copilot-instructions.md +46 -46
- package/templates/history.md +10 -10
- package/templates/identity/now.md +9 -9
- package/templates/identity/wisdom.md +15 -15
- package/templates/mcp-config.md +90 -90
- package/templates/multi-agent-format.md +28 -28
- package/templates/orchestration-log.md +27 -27
- package/templates/plugin-marketplace.md +49 -49
- package/templates/raw-agent-output.md +37 -37
- package/templates/roster.md +60 -60
- package/templates/routing.md +54 -54
- package/templates/run-output.md +50 -50
- package/templates/scribe-charter.md +119 -119
- package/templates/skill.md +24 -24
- package/templates/skills/squad-conventions/SKILL.md +69 -69
- package/templates/squad.agent.md +1146 -1146
- package/templates/workflows/squad-ci.yml +24 -24
- package/templates/workflows/squad-docs.yml +50 -50
- package/templates/workflows/squad-insider-release.yml +61 -61
- package/templates/workflows/squad-issue-assign.yml +161 -161
- package/templates/workflows/squad-label-enforce.yml +181 -181
- package/templates/workflows/squad-preview.yml +55 -55
- package/templates/workflows/squad-promote.yml +120 -120
- package/templates/workflows/squad-release.yml +77 -77
- package/templates/workflows/squad-triage.yml +260 -260
- package/templates/workflows/sync-squad-labels.yml +169 -169
- package/dist/cli/shell/sdk-bridge.d.ts +0 -50
- package/dist/cli/shell/sdk-bridge.d.ts.map +0 -1
- package/dist/cli/shell/sdk-bridge.js +0 -235
- package/dist/cli/shell/sdk-bridge.js.map +0 -1
- package/dist/cli/shell/theme-colors.d.ts +0 -39
- package/dist/cli/shell/theme-colors.d.ts.map +0 -1
- package/dist/cli/shell/theme-colors.js +0 -39
- package/dist/cli/shell/theme-colors.js.map +0 -1
- package/dist/cli.d.ts +0 -3
- package/dist/cli.d.ts.map +0 -1
- package/dist/cli.js +0 -4
- package/dist/cli.js.map +0 -1
- package/templates/workflows/squad-main-guard.yml +0 -129
package/templates/charter.md
CHANGED
|
@@ -1,53 +1,53 @@
|
|
|
1
|
-
# {Name} — {Role}
|
|
2
|
-
|
|
3
|
-
> {One-line personality statement — what makes this person tick}
|
|
4
|
-
|
|
5
|
-
## Identity
|
|
6
|
-
|
|
7
|
-
- **Name:** {Name}
|
|
8
|
-
- **Role:** {Role title}
|
|
9
|
-
- **Expertise:** {2-3 specific skills relevant to the project}
|
|
10
|
-
- **Style:** {How they communicate — direct? thorough? opinionated?}
|
|
11
|
-
|
|
12
|
-
## What I Own
|
|
13
|
-
|
|
14
|
-
- {Area of responsibility 1}
|
|
15
|
-
- {Area of responsibility 2}
|
|
16
|
-
- {Area of responsibility 3}
|
|
17
|
-
|
|
18
|
-
## How I Work
|
|
19
|
-
|
|
20
|
-
- {Key approach or principle 1}
|
|
21
|
-
- {Key approach or principle 2}
|
|
22
|
-
- {Pattern or convention I follow}
|
|
23
|
-
|
|
24
|
-
## Boundaries
|
|
25
|
-
|
|
26
|
-
**I handle:** {types of work this agent does}
|
|
27
|
-
|
|
28
|
-
**I don't handle:** {types of work that belong to other team members}
|
|
29
|
-
|
|
30
|
-
**When I'm unsure:** I say so and suggest who might know.
|
|
31
|
-
|
|
32
|
-
**If I review others' work:** On rejection, I may require a different agent to revise (not the original author) or request a new specialist be spawned. The Coordinator enforces this.
|
|
33
|
-
|
|
34
|
-
## Model
|
|
35
|
-
|
|
36
|
-
- **Preferred:** auto
|
|
37
|
-
- **Rationale:** Coordinator selects the best model based on task type — cost first unless writing code
|
|
38
|
-
- **Fallback:** Standard chain — the coordinator handles fallback automatically
|
|
39
|
-
|
|
40
|
-
## Collaboration
|
|
41
|
-
|
|
42
|
-
Before starting work, run `git rev-parse --show-toplevel` to find the repo root, or use the `TEAM ROOT` provided in the spawn prompt. All `.squad/` paths must be resolved relative to this root — do not assume CWD is the repo root (you may be in a worktree or subdirectory).
|
|
43
|
-
|
|
44
|
-
Before starting work, read `.squad/decisions.md` for team decisions that affect me.
|
|
45
|
-
After making a decision others should know, write it to `.squad/decisions/inbox/{my-name}-{brief-slug}.md` — the Scribe will merge it.
|
|
46
|
-
If I need another team member's input, say so — the coordinator will bring them in.
|
|
47
|
-
|
|
48
|
-
## Voice
|
|
49
|
-
|
|
50
|
-
{1-2 sentences describing personality. Not generic — specific. This agent has OPINIONS.
|
|
51
|
-
They have preferences. They push back. They have a style that's distinctly theirs.
|
|
52
|
-
Example: "Opinionated about test coverage. Will push back if tests are skipped.
|
|
53
|
-
Prefers integration tests over mocks. Thinks 80% coverage is the floor, not the ceiling."}
|
|
1
|
+
# {Name} — {Role}
|
|
2
|
+
|
|
3
|
+
> {One-line personality statement — what makes this person tick}
|
|
4
|
+
|
|
5
|
+
## Identity
|
|
6
|
+
|
|
7
|
+
- **Name:** {Name}
|
|
8
|
+
- **Role:** {Role title}
|
|
9
|
+
- **Expertise:** {2-3 specific skills relevant to the project}
|
|
10
|
+
- **Style:** {How they communicate — direct? thorough? opinionated?}
|
|
11
|
+
|
|
12
|
+
## What I Own
|
|
13
|
+
|
|
14
|
+
- {Area of responsibility 1}
|
|
15
|
+
- {Area of responsibility 2}
|
|
16
|
+
- {Area of responsibility 3}
|
|
17
|
+
|
|
18
|
+
## How I Work
|
|
19
|
+
|
|
20
|
+
- {Key approach or principle 1}
|
|
21
|
+
- {Key approach or principle 2}
|
|
22
|
+
- {Pattern or convention I follow}
|
|
23
|
+
|
|
24
|
+
## Boundaries
|
|
25
|
+
|
|
26
|
+
**I handle:** {types of work this agent does}
|
|
27
|
+
|
|
28
|
+
**I don't handle:** {types of work that belong to other team members}
|
|
29
|
+
|
|
30
|
+
**When I'm unsure:** I say so and suggest who might know.
|
|
31
|
+
|
|
32
|
+
**If I review others' work:** On rejection, I may require a different agent to revise (not the original author) or request a new specialist be spawned. The Coordinator enforces this.
|
|
33
|
+
|
|
34
|
+
## Model
|
|
35
|
+
|
|
36
|
+
- **Preferred:** auto
|
|
37
|
+
- **Rationale:** Coordinator selects the best model based on task type — cost first unless writing code
|
|
38
|
+
- **Fallback:** Standard chain — the coordinator handles fallback automatically
|
|
39
|
+
|
|
40
|
+
## Collaboration
|
|
41
|
+
|
|
42
|
+
Before starting work, run `git rev-parse --show-toplevel` to find the repo root, or use the `TEAM ROOT` provided in the spawn prompt. All `.squad/` paths must be resolved relative to this root — do not assume CWD is the repo root (you may be in a worktree or subdirectory).
|
|
43
|
+
|
|
44
|
+
Before starting work, read `.squad/decisions.md` for team decisions that affect me.
|
|
45
|
+
After making a decision others should know, write it to `.squad/decisions/inbox/{my-name}-{brief-slug}.md` — the Scribe will merge it.
|
|
46
|
+
If I need another team member's input, say so — the coordinator will bring them in.
|
|
47
|
+
|
|
48
|
+
## Voice
|
|
49
|
+
|
|
50
|
+
{1-2 sentences describing personality. Not generic — specific. This agent has OPINIONS.
|
|
51
|
+
They have preferences. They push back. They have a style that's distinctly theirs.
|
|
52
|
+
Example: "Opinionated about test coverage. Will push back if tests are skipped.
|
|
53
|
+
Prefers integration tests over mocks. Thinks 80% coverage is the floor, not the ceiling."}
|
|
@@ -1,38 +1,38 @@
|
|
|
1
|
-
# Constraint Budget Tracking
|
|
2
|
-
|
|
3
|
-
When the user or system imposes constraints (question limits, revision limits, time budgets), maintain a visible counter in your responses and in the artifact.
|
|
4
|
-
|
|
5
|
-
## Format
|
|
6
|
-
|
|
7
|
-
```
|
|
8
|
-
📊 Clarifying questions used: 2 / 3
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
## Rules
|
|
12
|
-
|
|
13
|
-
- Update the counter each time the constraint is consumed
|
|
14
|
-
- When a constraint is exhausted, state it: `📊 Question budget exhausted (3/3). Proceeding with current information.`
|
|
15
|
-
- If no constraints are active, do not display counters
|
|
16
|
-
- Include the final constraint status in multi-agent artifacts
|
|
17
|
-
|
|
18
|
-
## Example Session
|
|
19
|
-
|
|
20
|
-
```
|
|
21
|
-
Coordinator: Spawning agents to analyze requirements...
|
|
22
|
-
📊 Clarifying questions used: 0 / 3
|
|
23
|
-
|
|
24
|
-
Agent asks clarification: "Should we support OAuth?"
|
|
25
|
-
Coordinator: Checking with user...
|
|
26
|
-
📊 Clarifying questions used: 1 / 3
|
|
27
|
-
|
|
28
|
-
Agent asks clarification: "What's the rate limit?"
|
|
29
|
-
Coordinator: Checking with user...
|
|
30
|
-
📊 Clarifying questions used: 2 / 3
|
|
31
|
-
|
|
32
|
-
Agent asks clarification: "Do we need RBAC?"
|
|
33
|
-
Coordinator: Checking with user...
|
|
34
|
-
📊 Clarifying questions used: 3 / 3
|
|
35
|
-
|
|
36
|
-
Agent asks clarification: "Should we cache responses?"
|
|
37
|
-
Coordinator: 📊 Question budget exhausted (3/3). Proceeding without clarification.
|
|
38
|
-
```
|
|
1
|
+
# Constraint Budget Tracking
|
|
2
|
+
|
|
3
|
+
When the user or system imposes constraints (question limits, revision limits, time budgets), maintain a visible counter in your responses and in the artifact.
|
|
4
|
+
|
|
5
|
+
## Format
|
|
6
|
+
|
|
7
|
+
```
|
|
8
|
+
📊 Clarifying questions used: 2 / 3
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Rules
|
|
12
|
+
|
|
13
|
+
- Update the counter each time the constraint is consumed
|
|
14
|
+
- When a constraint is exhausted, state it: `📊 Question budget exhausted (3/3). Proceeding with current information.`
|
|
15
|
+
- If no constraints are active, do not display counters
|
|
16
|
+
- Include the final constraint status in multi-agent artifacts
|
|
17
|
+
|
|
18
|
+
## Example Session
|
|
19
|
+
|
|
20
|
+
```
|
|
21
|
+
Coordinator: Spawning agents to analyze requirements...
|
|
22
|
+
📊 Clarifying questions used: 0 / 3
|
|
23
|
+
|
|
24
|
+
Agent asks clarification: "Should we support OAuth?"
|
|
25
|
+
Coordinator: Checking with user...
|
|
26
|
+
📊 Clarifying questions used: 1 / 3
|
|
27
|
+
|
|
28
|
+
Agent asks clarification: "What's the rate limit?"
|
|
29
|
+
Coordinator: Checking with user...
|
|
30
|
+
📊 Clarifying questions used: 2 / 3
|
|
31
|
+
|
|
32
|
+
Agent asks clarification: "Do we need RBAC?"
|
|
33
|
+
Coordinator: Checking with user...
|
|
34
|
+
📊 Clarifying questions used: 3 / 3
|
|
35
|
+
|
|
36
|
+
Agent asks clarification: "Should we cache responses?"
|
|
37
|
+
Coordinator: 📊 Question budget exhausted (3/3). Proceeding without clarification.
|
|
38
|
+
```
|
|
@@ -1,46 +1,46 @@
|
|
|
1
|
-
# Copilot Coding Agent — Squad Instructions
|
|
2
|
-
|
|
3
|
-
You are working on a project that uses **Squad**, an AI team framework. When picking up issues autonomously, follow these guidelines.
|
|
4
|
-
|
|
5
|
-
## Team Context
|
|
6
|
-
|
|
7
|
-
Before starting work on any issue:
|
|
8
|
-
|
|
9
|
-
1. Read `.squad/team.md` for the team roster, member roles, and your capability profile.
|
|
10
|
-
2. Read `.squad/routing.md` for work routing rules.
|
|
11
|
-
3. If the issue has a `squad:{member}` label, read that member's charter at `.squad/agents/{member}/charter.md` to understand their domain expertise and coding style — work in their voice.
|
|
12
|
-
|
|
13
|
-
## Capability Self-Check
|
|
14
|
-
|
|
15
|
-
Before starting work, check your capability profile in `.squad/team.md` under the **Coding Agent → Capabilities** section.
|
|
16
|
-
|
|
17
|
-
- **🟢 Good fit** — proceed autonomously.
|
|
18
|
-
- **🟡 Needs review** — proceed, but note in the PR description that a squad member should review.
|
|
19
|
-
- **🔴 Not suitable** — do NOT start work. Instead, comment on the issue:
|
|
20
|
-
```
|
|
21
|
-
🤖 This issue doesn't match my capability profile (reason: {why}). Suggesting reassignment to a squad member.
|
|
22
|
-
```
|
|
23
|
-
|
|
24
|
-
## Branch Naming
|
|
25
|
-
|
|
26
|
-
Use the squad branch convention:
|
|
27
|
-
```
|
|
28
|
-
squad/{issue-number}-{kebab-case-slug}
|
|
29
|
-
```
|
|
30
|
-
Example: `squad/42-fix-login-validation`
|
|
31
|
-
|
|
32
|
-
## PR Guidelines
|
|
33
|
-
|
|
34
|
-
When opening a PR:
|
|
35
|
-
- Reference the issue: `Closes #{issue-number}`
|
|
36
|
-
- If the issue had a `squad:{member}` label, mention the member: `Working as {member} ({role})`
|
|
37
|
-
- If this is a 🟡 needs-review task, add to the PR description: `⚠️ This task was flagged as "needs review" — please have a squad member review before merging.`
|
|
38
|
-
- Follow any project conventions in `.squad/decisions.md`
|
|
39
|
-
|
|
40
|
-
## Decisions
|
|
41
|
-
|
|
42
|
-
If you make a decision that affects other team members, write it to:
|
|
43
|
-
```
|
|
44
|
-
.squad/decisions/inbox/copilot-{brief-slug}.md
|
|
45
|
-
```
|
|
46
|
-
The Scribe will merge it into the shared decisions file.
|
|
1
|
+
# Copilot Coding Agent — Squad Instructions
|
|
2
|
+
|
|
3
|
+
You are working on a project that uses **Squad**, an AI team framework. When picking up issues autonomously, follow these guidelines.
|
|
4
|
+
|
|
5
|
+
## Team Context
|
|
6
|
+
|
|
7
|
+
Before starting work on any issue:
|
|
8
|
+
|
|
9
|
+
1. Read `.squad/team.md` for the team roster, member roles, and your capability profile.
|
|
10
|
+
2. Read `.squad/routing.md` for work routing rules.
|
|
11
|
+
3. If the issue has a `squad:{member}` label, read that member's charter at `.squad/agents/{member}/charter.md` to understand their domain expertise and coding style — work in their voice.
|
|
12
|
+
|
|
13
|
+
## Capability Self-Check
|
|
14
|
+
|
|
15
|
+
Before starting work, check your capability profile in `.squad/team.md` under the **Coding Agent → Capabilities** section.
|
|
16
|
+
|
|
17
|
+
- **🟢 Good fit** — proceed autonomously.
|
|
18
|
+
- **🟡 Needs review** — proceed, but note in the PR description that a squad member should review.
|
|
19
|
+
- **🔴 Not suitable** — do NOT start work. Instead, comment on the issue:
|
|
20
|
+
```
|
|
21
|
+
🤖 This issue doesn't match my capability profile (reason: {why}). Suggesting reassignment to a squad member.
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Branch Naming
|
|
25
|
+
|
|
26
|
+
Use the squad branch convention:
|
|
27
|
+
```
|
|
28
|
+
squad/{issue-number}-{kebab-case-slug}
|
|
29
|
+
```
|
|
30
|
+
Example: `squad/42-fix-login-validation`
|
|
31
|
+
|
|
32
|
+
## PR Guidelines
|
|
33
|
+
|
|
34
|
+
When opening a PR:
|
|
35
|
+
- Reference the issue: `Closes #{issue-number}`
|
|
36
|
+
- If the issue had a `squad:{member}` label, mention the member: `Working as {member} ({role})`
|
|
37
|
+
- If this is a 🟡 needs-review task, add to the PR description: `⚠️ This task was flagged as "needs review" — please have a squad member review before merging.`
|
|
38
|
+
- Follow any project conventions in `.squad/decisions.md`
|
|
39
|
+
|
|
40
|
+
## Decisions
|
|
41
|
+
|
|
42
|
+
If you make a decision that affects other team members, write it to:
|
|
43
|
+
```
|
|
44
|
+
.squad/decisions/inbox/copilot-{brief-slug}.md
|
|
45
|
+
```
|
|
46
|
+
The Scribe will merge it into the shared decisions file.
|
package/templates/history.md
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
# Project Context
|
|
2
|
-
|
|
3
|
-
- **Owner:** {user name}
|
|
4
|
-
- **Project:** {project description}
|
|
5
|
-
- **Stack:** {languages, frameworks, tools}
|
|
6
|
-
- **Created:** {timestamp}
|
|
7
|
-
|
|
8
|
-
## Learnings
|
|
9
|
-
|
|
10
|
-
<!-- Append new learnings below. Each entry is something lasting about the project. -->
|
|
1
|
+
# Project Context
|
|
2
|
+
|
|
3
|
+
- **Owner:** {user name}
|
|
4
|
+
- **Project:** {project description}
|
|
5
|
+
- **Stack:** {languages, frameworks, tools}
|
|
6
|
+
- **Created:** {timestamp}
|
|
7
|
+
|
|
8
|
+
## Learnings
|
|
9
|
+
|
|
10
|
+
<!-- Append new learnings below. Each entry is something lasting about the project. -->
|
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
---
|
|
2
|
-
updated_at: {timestamp}
|
|
3
|
-
focus_area: {brief description}
|
|
4
|
-
active_issues: []
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# What We're Focused On
|
|
8
|
-
|
|
9
|
-
{Narrative description of current focus — 1-3 sentences. Updated by coordinator at session start.}
|
|
1
|
+
---
|
|
2
|
+
updated_at: {timestamp}
|
|
3
|
+
focus_area: {brief description}
|
|
4
|
+
active_issues: []
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# What We're Focused On
|
|
8
|
+
|
|
9
|
+
{Narrative description of current focus — 1-3 sentences. Updated by coordinator at session start.}
|
|
@@ -1,15 +1,15 @@
|
|
|
1
|
-
---
|
|
2
|
-
last_updated: {timestamp}
|
|
3
|
-
---
|
|
4
|
-
|
|
5
|
-
# Team Wisdom
|
|
6
|
-
|
|
7
|
-
Reusable patterns and heuristics learned through work. NOT transcripts — each entry is a distilled, actionable insight.
|
|
8
|
-
|
|
9
|
-
## Patterns
|
|
10
|
-
|
|
11
|
-
<!-- Append entries below. Format: **Pattern:** description. **Context:** when it applies. -->
|
|
12
|
-
|
|
13
|
-
## Anti-Patterns
|
|
14
|
-
|
|
15
|
-
<!-- Things we tried that didn't work. **Avoid:** description. **Why:** reason. -->
|
|
1
|
+
---
|
|
2
|
+
last_updated: {timestamp}
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# Team Wisdom
|
|
6
|
+
|
|
7
|
+
Reusable patterns and heuristics learned through work. NOT transcripts — each entry is a distilled, actionable insight.
|
|
8
|
+
|
|
9
|
+
## Patterns
|
|
10
|
+
|
|
11
|
+
<!-- Append entries below. Format: **Pattern:** description. **Context:** when it applies. -->
|
|
12
|
+
|
|
13
|
+
## Anti-Patterns
|
|
14
|
+
|
|
15
|
+
<!-- Things we tried that didn't work. **Avoid:** description. **Why:** reason. -->
|
package/templates/mcp-config.md
CHANGED
|
@@ -1,90 +1,90 @@
|
|
|
1
|
-
# MCP Integration — Configuration and Samples
|
|
2
|
-
|
|
3
|
-
MCP (Model Context Protocol) servers extend Squad with tools for external services — Trello, Aspire dashboards, Azure, Notion, and more. The user configures MCP servers in their environment; Squad discovers and uses them.
|
|
4
|
-
|
|
5
|
-
> **Full patterns:** Read `.squad/skills/mcp-tool-discovery/SKILL.md` for discovery patterns, domain-specific usage, and graceful degradation.
|
|
6
|
-
|
|
7
|
-
## Config File Locations
|
|
8
|
-
|
|
9
|
-
Users configure MCP servers at these locations (checked in priority order):
|
|
10
|
-
1. **Repository-level:** `.copilot/mcp-config.json` (team-shared, committed to repo)
|
|
11
|
-
2. **Workspace-level:** `.vscode/mcp.json` (VS Code workspaces)
|
|
12
|
-
3. **User-level:** `~/.copilot/mcp-config.json` (personal)
|
|
13
|
-
4. **CLI override:** `--additional-mcp-config` flag (session-specific)
|
|
14
|
-
|
|
15
|
-
## Sample Config — Trello
|
|
16
|
-
|
|
17
|
-
```json
|
|
18
|
-
{
|
|
19
|
-
"mcpServers": {
|
|
20
|
-
"trello": {
|
|
21
|
-
"command": "npx",
|
|
22
|
-
"args": ["-y", "@trello/mcp-server"],
|
|
23
|
-
"env": {
|
|
24
|
-
"TRELLO_API_KEY": "${TRELLO_API_KEY}",
|
|
25
|
-
"TRELLO_TOKEN": "${TRELLO_TOKEN}"
|
|
26
|
-
}
|
|
27
|
-
}
|
|
28
|
-
}
|
|
29
|
-
}
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
## Sample Config — GitHub
|
|
33
|
-
|
|
34
|
-
```json
|
|
35
|
-
{
|
|
36
|
-
"mcpServers": {
|
|
37
|
-
"github": {
|
|
38
|
-
"command": "npx",
|
|
39
|
-
"args": ["-y", "@modelcontextprotocol/server-github"],
|
|
40
|
-
"env": {
|
|
41
|
-
"GITHUB_TOKEN": "${GITHUB_TOKEN}"
|
|
42
|
-
}
|
|
43
|
-
}
|
|
44
|
-
}
|
|
45
|
-
}
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
## Sample Config — Azure
|
|
49
|
-
|
|
50
|
-
```json
|
|
51
|
-
{
|
|
52
|
-
"mcpServers": {
|
|
53
|
-
"azure": {
|
|
54
|
-
"command": "npx",
|
|
55
|
-
"args": ["-y", "@azure/mcp-server"],
|
|
56
|
-
"env": {
|
|
57
|
-
"AZURE_SUBSCRIPTION_ID": "${AZURE_SUBSCRIPTION_ID}",
|
|
58
|
-
"AZURE_CLIENT_ID": "${AZURE_CLIENT_ID}",
|
|
59
|
-
"AZURE_CLIENT_SECRET": "${AZURE_CLIENT_SECRET}",
|
|
60
|
-
"AZURE_TENANT_ID": "${AZURE_TENANT_ID}"
|
|
61
|
-
}
|
|
62
|
-
}
|
|
63
|
-
}
|
|
64
|
-
}
|
|
65
|
-
```
|
|
66
|
-
|
|
67
|
-
## Sample Config — Aspire
|
|
68
|
-
|
|
69
|
-
```json
|
|
70
|
-
{
|
|
71
|
-
"mcpServers": {
|
|
72
|
-
"aspire": {
|
|
73
|
-
"command": "npx",
|
|
74
|
-
"args": ["-y", "@aspire/mcp-server"],
|
|
75
|
-
"env": {
|
|
76
|
-
"ASPIRE_DASHBOARD_URL": "${ASPIRE_DASHBOARD_URL}"
|
|
77
|
-
}
|
|
78
|
-
}
|
|
79
|
-
}
|
|
80
|
-
}
|
|
81
|
-
```
|
|
82
|
-
|
|
83
|
-
## Authentication Notes
|
|
84
|
-
|
|
85
|
-
- **GitHub MCP requires a separate token** from the `gh` CLI auth. Generate at https://github.com/settings/tokens
|
|
86
|
-
- **Trello requires API key + token** from https://trello.com/power-ups/admin
|
|
87
|
-
- **Azure requires service principal credentials** — see Azure docs for setup
|
|
88
|
-
- **Aspire uses the dashboard URL** — typically `http://localhost:18888` during local dev
|
|
89
|
-
|
|
90
|
-
Auth is a real blocker for some MCP servers. Users need separate tokens for GitHub MCP, Azure MCP, Trello MCP, etc. This is a documentation problem, not a code problem.
|
|
1
|
+
# MCP Integration — Configuration and Samples
|
|
2
|
+
|
|
3
|
+
MCP (Model Context Protocol) servers extend Squad with tools for external services — Trello, Aspire dashboards, Azure, Notion, and more. The user configures MCP servers in their environment; Squad discovers and uses them.
|
|
4
|
+
|
|
5
|
+
> **Full patterns:** Read `.squad/skills/mcp-tool-discovery/SKILL.md` for discovery patterns, domain-specific usage, and graceful degradation.
|
|
6
|
+
|
|
7
|
+
## Config File Locations
|
|
8
|
+
|
|
9
|
+
Users configure MCP servers at these locations (checked in priority order):
|
|
10
|
+
1. **Repository-level:** `.copilot/mcp-config.json` (team-shared, committed to repo)
|
|
11
|
+
2. **Workspace-level:** `.vscode/mcp.json` (VS Code workspaces)
|
|
12
|
+
3. **User-level:** `~/.copilot/mcp-config.json` (personal)
|
|
13
|
+
4. **CLI override:** `--additional-mcp-config` flag (session-specific)
|
|
14
|
+
|
|
15
|
+
## Sample Config — Trello
|
|
16
|
+
|
|
17
|
+
```json
|
|
18
|
+
{
|
|
19
|
+
"mcpServers": {
|
|
20
|
+
"trello": {
|
|
21
|
+
"command": "npx",
|
|
22
|
+
"args": ["-y", "@trello/mcp-server"],
|
|
23
|
+
"env": {
|
|
24
|
+
"TRELLO_API_KEY": "${TRELLO_API_KEY}",
|
|
25
|
+
"TRELLO_TOKEN": "${TRELLO_TOKEN}"
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Sample Config — GitHub
|
|
33
|
+
|
|
34
|
+
```json
|
|
35
|
+
{
|
|
36
|
+
"mcpServers": {
|
|
37
|
+
"github": {
|
|
38
|
+
"command": "npx",
|
|
39
|
+
"args": ["-y", "@modelcontextprotocol/server-github"],
|
|
40
|
+
"env": {
|
|
41
|
+
"GITHUB_TOKEN": "${GITHUB_TOKEN}"
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## Sample Config — Azure
|
|
49
|
+
|
|
50
|
+
```json
|
|
51
|
+
{
|
|
52
|
+
"mcpServers": {
|
|
53
|
+
"azure": {
|
|
54
|
+
"command": "npx",
|
|
55
|
+
"args": ["-y", "@azure/mcp-server"],
|
|
56
|
+
"env": {
|
|
57
|
+
"AZURE_SUBSCRIPTION_ID": "${AZURE_SUBSCRIPTION_ID}",
|
|
58
|
+
"AZURE_CLIENT_ID": "${AZURE_CLIENT_ID}",
|
|
59
|
+
"AZURE_CLIENT_SECRET": "${AZURE_CLIENT_SECRET}",
|
|
60
|
+
"AZURE_TENANT_ID": "${AZURE_TENANT_ID}"
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## Sample Config — Aspire
|
|
68
|
+
|
|
69
|
+
```json
|
|
70
|
+
{
|
|
71
|
+
"mcpServers": {
|
|
72
|
+
"aspire": {
|
|
73
|
+
"command": "npx",
|
|
74
|
+
"args": ["-y", "@aspire/mcp-server"],
|
|
75
|
+
"env": {
|
|
76
|
+
"ASPIRE_DASHBOARD_URL": "${ASPIRE_DASHBOARD_URL}"
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
## Authentication Notes
|
|
84
|
+
|
|
85
|
+
- **GitHub MCP requires a separate token** from the `gh` CLI auth. Generate at https://github.com/settings/tokens
|
|
86
|
+
- **Trello requires API key + token** from https://trello.com/power-ups/admin
|
|
87
|
+
- **Azure requires service principal credentials** — see Azure docs for setup
|
|
88
|
+
- **Aspire uses the dashboard URL** — typically `http://localhost:18888` during local dev
|
|
89
|
+
|
|
90
|
+
Auth is a real blocker for some MCP servers. Users need separate tokens for GitHub MCP, Azure MCP, Trello MCP, etc. This is a documentation problem, not a code problem.
|
|
@@ -1,28 +1,28 @@
|
|
|
1
|
-
# Multi-Agent Artifact Format
|
|
2
|
-
|
|
3
|
-
When multiple agents contribute to a final artifact (document, analysis, design), use this format. The assembled result must include:
|
|
4
|
-
|
|
5
|
-
- Termination condition
|
|
6
|
-
- Constraint budgets (if active)
|
|
7
|
-
- Reviewer verdicts (if any)
|
|
8
|
-
- Raw agent outputs appendix
|
|
9
|
-
|
|
10
|
-
## Assembly Structure
|
|
11
|
-
|
|
12
|
-
The assembled result goes at the top. Below it, include:
|
|
13
|
-
|
|
14
|
-
```
|
|
15
|
-
## APPENDIX: RAW AGENT OUTPUTS
|
|
16
|
-
|
|
17
|
-
### {Name} ({Role}) — Raw Output
|
|
18
|
-
{Paste agent's verbatim response here, unedited}
|
|
19
|
-
|
|
20
|
-
### {Name} ({Role}) — Raw Output
|
|
21
|
-
{Paste agent's verbatim response here, unedited}
|
|
22
|
-
```
|
|
23
|
-
|
|
24
|
-
## Appendix Rules
|
|
25
|
-
|
|
26
|
-
This appendix is for diagnostic integrity. Do not edit, summarize, or polish the raw outputs. The Coordinator may not rewrite raw agent outputs; it may only paste them verbatim and assemble the final artifact above.
|
|
27
|
-
|
|
28
|
-
See `.squad/templates/run-output.md` for the complete output format template.
|
|
1
|
+
# Multi-Agent Artifact Format
|
|
2
|
+
|
|
3
|
+
When multiple agents contribute to a final artifact (document, analysis, design), use this format. The assembled result must include:
|
|
4
|
+
|
|
5
|
+
- Termination condition
|
|
6
|
+
- Constraint budgets (if active)
|
|
7
|
+
- Reviewer verdicts (if any)
|
|
8
|
+
- Raw agent outputs appendix
|
|
9
|
+
|
|
10
|
+
## Assembly Structure
|
|
11
|
+
|
|
12
|
+
The assembled result goes at the top. Below it, include:
|
|
13
|
+
|
|
14
|
+
```
|
|
15
|
+
## APPENDIX: RAW AGENT OUTPUTS
|
|
16
|
+
|
|
17
|
+
### {Name} ({Role}) — Raw Output
|
|
18
|
+
{Paste agent's verbatim response here, unedited}
|
|
19
|
+
|
|
20
|
+
### {Name} ({Role}) — Raw Output
|
|
21
|
+
{Paste agent's verbatim response here, unedited}
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Appendix Rules
|
|
25
|
+
|
|
26
|
+
This appendix is for diagnostic integrity. Do not edit, summarize, or polish the raw outputs. The Coordinator may not rewrite raw agent outputs; it may only paste them verbatim and assemble the final artifact above.
|
|
27
|
+
|
|
28
|
+
See `.squad/templates/run-output.md` for the complete output format template.
|
|
@@ -1,27 +1,27 @@
|
|
|
1
|
-
# Orchestration Log Entry
|
|
2
|
-
|
|
3
|
-
> One file per agent spawn. Saved to `.squad/orchestration-log/{timestamp}-{agent-name}.md`
|
|
4
|
-
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
### {timestamp} — {task summary}
|
|
8
|
-
|
|
9
|
-
| Field | Value |
|
|
10
|
-
|-------|-------|
|
|
11
|
-
| **Agent routed** | {Name} ({Role}) |
|
|
12
|
-
| **Why chosen** | {Routing rationale — what in the request matched this agent} |
|
|
13
|
-
| **Mode** | {`background` / `sync`} |
|
|
14
|
-
| **Why this mode** | {Brief reason — e.g., "No hard data dependencies" or "User needs to approve architecture"} |
|
|
15
|
-
| **Files authorized to read** | {Exact file paths the agent was told to read} |
|
|
16
|
-
| **File(s) agent must produce** | {Exact file paths the agent is expected to create or modify} |
|
|
17
|
-
| **Outcome** | {Completed / Rejected by {Reviewer} / Escalated} |
|
|
18
|
-
|
|
19
|
-
---
|
|
20
|
-
|
|
21
|
-
## Rules
|
|
22
|
-
|
|
23
|
-
1. **One file per agent spawn.** Named `{timestamp}-{agent-name}.md`. Timestamps must be filename-safe (replace colons with hyphens, e.g., `2026-02-23T20-16-27Z`).
|
|
24
|
-
2. **Log BEFORE spawning.** The entry must exist before the agent runs.
|
|
25
|
-
3. **Update outcome AFTER the agent completes.** Fill in the Outcome field.
|
|
26
|
-
4. **Never delete or edit past entries.** Append-only.
|
|
27
|
-
5. **If a reviewer rejects work,** log the rejection as a new entry with the revision agent.
|
|
1
|
+
# Orchestration Log Entry
|
|
2
|
+
|
|
3
|
+
> One file per agent spawn. Saved to `.squad/orchestration-log/{timestamp}-{agent-name}.md`
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
### {timestamp} — {task summary}
|
|
8
|
+
|
|
9
|
+
| Field | Value |
|
|
10
|
+
|-------|-------|
|
|
11
|
+
| **Agent routed** | {Name} ({Role}) |
|
|
12
|
+
| **Why chosen** | {Routing rationale — what in the request matched this agent} |
|
|
13
|
+
| **Mode** | {`background` / `sync`} |
|
|
14
|
+
| **Why this mode** | {Brief reason — e.g., "No hard data dependencies" or "User needs to approve architecture"} |
|
|
15
|
+
| **Files authorized to read** | {Exact file paths the agent was told to read} |
|
|
16
|
+
| **File(s) agent must produce** | {Exact file paths the agent is expected to create or modify} |
|
|
17
|
+
| **Outcome** | {Completed / Rejected by {Reviewer} / Escalated} |
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
## Rules
|
|
22
|
+
|
|
23
|
+
1. **One file per agent spawn.** Named `{timestamp}-{agent-name}.md`. Timestamps must be filename-safe (replace colons with hyphens, e.g., `2026-02-23T20-16-27Z`).
|
|
24
|
+
2. **Log BEFORE spawning.** The entry must exist before the agent runs.
|
|
25
|
+
3. **Update outcome AFTER the agent completes.** Fill in the Outcome field.
|
|
26
|
+
4. **Never delete or edit past entries.** Append-only.
|
|
27
|
+
5. **If a reviewer rejects work,** log the rejection as a new entry with the revision agent.
|