Skip to main content

Start with NuGet packages

Use these steps if you want to add SharpOMatic to an existing ASP.NET Core project.
You could start from scratch by creating a new ASP.NET Core project and then running these steps.

Install packages​

dotnet add package SharpOMatic.Engine
dotnet add package SharpOMatic.Engine.Sqlite
dotnet add package SharpOMatic.Editor
dotnet add package SharpOMatic.AGUI

For SQL Server, install SharpOMatic.Engine.SqlServer instead of SharpOMatic.Engine.Sqlite. The SharpOMatic.AGUI package exposes the AG-UI endpoint used by the AG-UI samples and the Sharpy client sample.

Provider SDK versions​

SharpOMatic's model connectors depend on specific OpenAI, Azure OpenAI, Microsoft Agents AI, and Google SDK versions. When you install the SharpOMatic packages, let NuGet resolve those provider SDK dependencies from the SharpOMatic package graph.

Do not independently upgrade the OpenAI/Azure model-calling packages in the host application unless you are also updating SharpOMatic source code to match the newer SDK APIs. The OpenAI and Azure OpenAI SDKs are still changing quickly, and newer package combinations can change type names and tool-calling behavior. SharpOMatic is tested against the provider SDK versions referenced by the current SharpOMatic projects and packages.

Register services​

Update Program.cs to add the required services. The following example stores library assets and a SQLite database in your user profile. This gets you up and running quickly and isolates the data to the current user.

For example, if your username is JohnDoe, then the files will be at:
C:\Users\JohnDoe\AppData\Local\SharpOMatic

  builder.Services.AddCors();

  // Assets are stored in the current user's profile
  builder.Services.Configure<FileSystemAssetStoreOptions>(
    builder.Configuration.GetSection("AssetStorage:FileSystem"));
  builder.Services.AddSingleton<IAssetStore, FileSystemAssetStore>();

  builder.Services.AddSharpOMaticEditor();
  builder.Services.AddSharpOMaticTransfer();
  builder.Services.AddSharpOMaticAgUi();
  builder.Services.AddSharpOMaticEngine()
    .AddSqliteRepository(
      connectionString: $"Data Source={Path.Join(Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData), "sharpomatic.db")}");

The first line enables CORS so browser-based AG-UI clients such as Sharpy can connect during local development. The asset storage lines are used to setup how assets are stored. It uses the file system implementation which is the easiest for getting started. We want to use the browser based editor and so need to call AddSharpOMaticEditor. To enable import and export we then add AddSharpOMaticTransfer. To enable the AG-UI samples and the Sharpy client sample, add AddSharpOMaticAgUi. Finally the AddSharpOMaticEngine call is used to setup the repository. For simplicity we use SQLite, it will create the database automatically on first start.

If you want SQL Server:

dotnet add package SharpOMatic.Engine.SqlServer
  builder.Services.AddSharpOMaticEngine()
    .AddSqlServerRepository(
      connectionString: builder.Configuration.GetConnectionString("SharpOMatic")!);

Map the editor UI​

  app.UseCors(policy => policy.AllowAnyOrigin().AllowAnyMethod().AllowAnyHeader());
  app.MapControllers();

  app.MapSharpOMaticEditor();

By default SharpOMatic uses a base path of /sharpomatic. That gives you:

  • Editor UI: /sharpomatic/editor
  • Editor and transfer APIs: /sharpomatic/api/...
  • AG-UI: /sharpomatic/api/agui

Sharpy is configured to call http://localhost:9000/sharpomatic/api/agui by default. If your host uses another port or base path, update the Sharpy AG-UI URL to match. For setup and workflow-mode settings, see Sharpy client sample.

If you want a different base path, define one variable and use it consistently:

  var sharpOMaticBasePath = "/banana";

  builder.Services.AddSharpOMaticEditor(sharpOMaticBasePath);
  builder.Services.AddSharpOMaticTransfer(sharpOMaticBasePath);
  builder.Services.AddSharpOMaticAgUi(sharpOMaticBasePath);

  app.MapControllers();
  app.MapSharpOMaticEditor(sharpOMaticBasePath);

MapSharpOMaticEditor automatically appends /editor to the base path. AddSharpOMaticAgUi defaults its child path to /api/agui, but you can override that too:

  builder.Services.AddSharpOMaticAgUi("/banana", "/integrations/chat");

Open visual editor​

Check the generated port number for new project in the launchSettings.json.
NOTE: The demo server uses https://localhost:9001 and http://localhost:9000 by default. Replace those ports if your host uses different values.

Use your favorite browser to open https://localhost:9001/sharpomatic/editor

Once the editor is open, follow Use Samples to create and run a sample workflow.