Skip to content

README.md

Latest commit

 

History

History
85 lines (59 loc) · 3.14 KB

README.md

File metadata and controls

85 lines (59 loc) · 3.14 KB
Raw

CommunityToolkit.Aspire.Hosting.Squad

An Aspire hosting integration that lets you model a Squad AI-agent team as a first-class .NET Aspire resource.

Getting Started

Install the package

dotnet add package CommunityToolkit.Aspire.Hosting.Squad

Add a Squad team to your AppHost

using Aspire.Hosting;

var builder = DistributedApplication.CreateBuilder(args);

// Register a Squad team as a logical Aspire resource.
// teamRoot is the directory that contains the `.squad/` folder.
var research = builder.AddSquad("research-squad",
    teamRoot: @"C:\repos\my-research-team");

// Wire the team into a downstream service project.
// The service receives a `squad://...` connection string describing the team.
builder.AddProject<Projects.MyApi>("api")
    .WithReference(research)
    .WithHttpEndpoint(name: "http", env: "HTTP_PORTS");

builder.Build().Run();

Consume the team from a service project

In a referenced service project, parse the connection string Aspire injects under ConnectionStrings:{resourceName} (format squad://resource/{name}?teamRoot=...&agents=...&protocol=maf-1.0) and use Squad.Agents.AI to construct a SquadAgent over the referenced team:

var teamRoot = ParseTeamRoot(builder.Configuration.GetConnectionString("research-squad")!);

builder.Services.AddSquadAgent(opts =>
{
    opts.SquadFolderPath = teamRoot;
    opts.Instructions = "You are a research assistant. Be concise.";
});

app.MapPost("/ask", async (string prompt, SquadAgent agent) =>
{
    var session = await agent.CreateSessionAsync();
    var response = await agent.RunAsync(prompt, session);
    return Results.Ok(new { response = response.Text });
});

A complete runnable example lives under examples/squad/ — AppHost + ApiApp wired together with a self-contained sample team.

What it does

AddSquad(name, teamRoot) registers a SquadResource that:

  • Reads the team roster from {teamRoot}/.squad/team.md
  • Surfaces the roster, team root, and protocol version as dashboard properties
  • Implements IResourceWithConnectionString so downstream services can .WithReference(squad) and receive a squad://resource/{name}?teamRoot={...}&agents={csv}&protocol=maf-1.0 descriptor

The resource is logical — it does not start a listener by itself. Service projects that reference the squad can use the connection string to instantiate a Squad.Agents.AI AIAgent (Microsoft Agent Framework adapter) that orchestrates the referenced team.

Roster discovery

The integration parses .squad/team.md looking for either of:

| Ralph     | Work Monitor   | ... |
- **Ralph** (Work Monitor)

Only names whose lowercase form maps to an existing .squad/agents/{name}/charter.md are kept. If team.md does not exist, a sensible default roster is returned so the resource is still useful.

Feedback & contributing

Issues and PRs welcome at CommunityToolkit/Aspire.