AgentCircuits.Server
0.5.2
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package AgentCircuits.Server --version 0.5.2
NuGet\Install-Package AgentCircuits.Server -Version 0.5.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="AgentCircuits.Server" Version="0.5.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="AgentCircuits.Server" Version="0.5.2" />
<PackageReference Include="AgentCircuits.Server" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add AgentCircuits.Server --version 0.5.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: AgentCircuits.Server, 0.5.2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package AgentCircuits.Server@0.5.2
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=AgentCircuits.Server&version=0.5.2
#tool nuget:?package=AgentCircuits.Server&version=0.5.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
AgentCircuits.Server
Turnkey host for AgentCircuits Portal API, SignalR hubs, and UI endpoints. This package provides a runnable server that wires AgentCircuits.Portal + AgentCircuits.UI together using configuration.
Installation
NuGet Package
dotnet add package AgentCircuits.Server
Then create a minimal host:
// Program.cs
AgentCircuits.Server.Program.Run(args);
Docker Image
docker pull ghcr.io/agent-circuits/agentcircuits-server:latest
docker run -p 8080:8080 \
-v ./data:/data \
-e AGENTCIRCUITS__PROVIDERS__ANTHROPIC__API_KEY=sk-ant-... \
ghcr.io/agent-circuits/agentcircuits-server:latest
Self-Contained Executable
Download from GitHub Releases or build locally:
./publish.sh linux-x64 # Linux
./publish.sh win-x64 # Windows
./publish.sh osx-arm64 # macOS Apple Silicon
Output is in publish/<runtime>/.
Configuration
The server reads appsettings.json from the working directory. Key settings:
| Setting | Description | Default |
|---|---|---|
AgentCircuits:PathBase |
Base path prefix for all routes | (none) |
AgentCircuits:Storage:Mode |
File, InMemory, or Sql |
File |
AgentCircuits:Storage:Path |
File storage directory | ./data |
AgentCircuits:Portal:BasePath |
Mount path for Portal UI | /portal |
AgentCircuits:UI:BasePath |
Mount path for Chat UI | /chat |
AgentCircuits:Providers:<name>:enabled |
Enable/disable provider | varies |
Environment Variables
Use __ as section separator:
AGENTCIRCUITS__STORAGE__MODE=Sql
AGENTCIRCUITS__STORAGE__CONNECTIONSTRING=Host=localhost;Database=agentcircuits
AGENTCIRCUITS__PROVIDERS__ANTHROPIC__ENABLED=true
AGENTCIRCUITS__PROVIDERS__ANTHROPIC__API_KEY=sk-ant-...
Local Development
Run from the monorepo root:
dotnet run --project agentcircuits.server/src/AgentCircuits.Server.csproj
This builds UI assets automatically (requires Node.js). To skip UI builds:
dotnet build -p:SkipNpmBuild=true
Docker
From GHCR (recommended)
docker run -p 8080:8080 \
-v ./data:/data \
-e AGENTCIRCUITS__PROVIDERS__ANTHROPIC__API_KEY=sk-ant-... \
ghcr.io/agent-circuits/agentcircuits-server:latest
Build from Server Repo
docker build -t agentcircuits-server:local .
Build from Monorepo
# From monorepo root
docker build -f agentcircuits.server/Dockerfile.monorepo -t agentcircuits-server:local .
Docker Compose
docker compose up
See docker-compose.yml for PostgreSQL setup example.
Health Check
GET /health returns {"status":"ok"} (respects PathBase if set).
Publishing
Automated (CI)
Pushing a v* tag triggers:
- NuGet package published to nuget.org
- Docker image published to ghcr.io
Manual
# NuGet package
dotnet pack src/AgentCircuits.Server.csproj -c Release -o ./artifacts
# Self-contained executable
./publish.sh linux-x64
# Docker image
docker build -t myregistry/agentcircuits-server:v1.0.0 .
docker push myregistry/agentcircuits-server:v1.0.0
Customisation
For custom tools or services, create your own host project:
AgentCircuits.Server.Program.Run(args, builder =>
{
builder.Services.AddSingleton<IMyService, MyService>();
});
Links
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net9.0
- AgentCircuits.Portal (>= 0.5.2)
- AgentCircuits.Providers.Anthropic (>= 0.5.2)
- AgentCircuits.Providers.Bedrock (>= 0.5.2)
- AgentCircuits.Providers.Gemini (>= 0.5.2)
- AgentCircuits.Providers.Grok (>= 0.5.2)
- AgentCircuits.Providers.Ollama (>= 0.5.2)
- AgentCircuits.Providers.OpenAI (>= 0.5.2)
- AgentCircuits.Storage.Sql (>= 0.5.2)
- AgentCircuits.UI (>= 0.5.2)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.