diff --git a/.github/workflows/propose_release.yml b/.github/workflows/propose_release.yml
new file mode 100644
index 0000000..49448c3
--- /dev/null
+++ b/.github/workflows/propose_release.yml
@@ -0,0 +1,28 @@
+name: Propose Stable Release
+on:
+ workflow_dispatch:
+ inputs:
+ release_type:
+ type: choice
+ description: Release Type
+ options:
+ - patch
+ - minor
+ - major
+jobs:
+ update_version:
+ uses: neongeckocom/.github/.github/workflows/propose_semver_release.yml@master
+ with:
+ branch: dev
+ release_type: ${{ inputs.release_type }}
+ update_changelog: True
+ version_file: "brainforge_inference_utils/version.py"
+ pull_changes:
+ uses: neongeckocom/.github/.github/workflows/pull_master.yml@master
+ needs: update_version
+ with:
+ pr_reviewer: neonreviewers
+ pr_assignee: ${{ github.actor }}
+ pr_draft: false
+ pr_title: ${{ needs.update_version.outputs.version }}
+ pr_body: ${{ needs.update_version.outputs.changelog }}
diff --git a/.github/workflows/publish_release.yml b/.github/workflows/publish_release.yml
new file mode 100644
index 0000000..e4b3fa3
--- /dev/null
+++ b/.github/workflows/publish_release.yml
@@ -0,0 +1,12 @@
+# This workflow will generate a release distribution and upload it to PyPI
+
+name: Publish Build and GitHub Release
+on:
+ push:
+ branches:
+ - master
+
+jobs:
+ build_and_publish_pypi_and_release:
+ uses: neongeckocom/.github/.github/workflows/publish_stable_release.yml@master
+ secrets: inherit
diff --git a/.github/workflows/publish_test_build.yml b/.github/workflows/publish_test_build.yml
new file mode 100644
index 0000000..a5bdbe9
--- /dev/null
+++ b/.github/workflows/publish_test_build.yml
@@ -0,0 +1,16 @@
+name: Publish Alpha Build
+on:
+ push:
+ branches:
+ - dev
+ paths-ignore:
+ - 'brainforge_inference_utils/version.py'
+
+jobs:
+ publish_alpha_release:
+ uses: neongeckocom/.github/.github/workflows/publish_alpha_release.yml@master
+ secrets: inherit
+ with:
+ publish_pypi: true
+ version_file: "brainforge_inference_utils/version.py"
+ publish_prerelease: true
diff --git a/.github/workflows/unit_tests.yml b/.github/workflows/unit_tests.yml
new file mode 100644
index 0000000..ef8f860
--- /dev/null
+++ b/.github/workflows/unit_tests.yml
@@ -0,0 +1,33 @@
+name: Run Unit Tests
+on:
+ pull_request:
+ workflow_dispatch:
+
+jobs:
+ python_build_tests:
+ uses: neongeckocom/.github/.github/workflows/python_build_tests.yml@master
+ unit_tests:
+ timeout-minutes: 15
+ strategy:
+ fail-fast: false
+ matrix:
+ python-version: ["3.11", "3.12", "3.13"]
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v4
+ - name: Set up Python ${{ matrix.python-version }}
+ uses: actions/setup-python@v5
+ with:
+ python-version: ${{ matrix.python-version }}
+ - name: Install dependencies
+ run: |
+ python -m pip install --upgrade pip
+ pip install --no-cache-dir .[test]
+ - name: Unit tests
+ run: pytest tests -v --junitxml=tests/unit-test-results.xml
+ - name: Upload test results
+ if: always()
+ uses: actions/upload-artifact@v4
+ with:
+ name: unit-test-results-${{ matrix.python-version }}
+ path: tests/unit-test-results.xml
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..65b543a
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,377 @@
+## Ignore Visual Studio temporary files, build results, and
+## files generated by popular Visual Studio add-ons.
+##
+## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore
+
+# User-specific files
+*.rsuser
+*.suo
+*.user
+*.userosscache
+*.sln.docstates
+
+# User-specific files (MonoDevelop/Xamarin Studio)
+*.userprefs
+
+# Mono auto generated files
+mono_crash.*
+
+# Build results
+[Dd]ebug/
+[Dd]ebugPublic/
+[Rr]elease/
+[Rr]eleases/
+x64/
+x86/
+[Ww][Ii][Nn]32/
+[Aa][Rr][Mm]/
+[Aa][Rr][Mm]64/
+bld/
+[Bb]in/
+[Oo]bj/
+[Oo]ut/
+[Ll]og/
+[Ll]ogs/
+
+# Visual Studio 2015/2017 cache/options directory
+.vs/
+# Uncomment if you have tasks that create the project's static files in wwwroot
+#wwwroot/
+
+# Visual Studio 2017 auto generated files
+Generated\ Files/
+
+# MSTest test Results
+[Tt]est[Rr]esult*/
+[Bb]uild[Ll]og.*
+
+# NUnit
+*.VisualState.xml
+TestResult.xml
+nunit-*.xml
+
+# Build Results of an ATL Project
+[Dd]ebugPS/
+[Rr]eleasePS/
+dlldata.c
+
+# Benchmark Results
+BenchmarkDotNet.Artifacts/
+
+# .NET Core
+project.lock.json
+project.fragment.lock.json
+artifacts/
+
+# ASP.NET Scaffolding
+ScaffoldingReadMe.txt
+
+# StyleCop
+StyleCopReport.xml
+
+# Files built by Visual Studio
+*_i.c
+*_p.c
+*_h.h
+*.ilk
+*.meta
+*.obj
+*.iobj
+*.pch
+*.pdb
+*.ipdb
+*.pgc
+*.pgd
+*.rsp
+*.sbr
+*.tlb
+*.tli
+*.tlh
+*.tmp
+*.tmp_proj
+*_wpftmp.csproj
+*.log
+*.vspscc
+*.vssscc
+.builds
+*.pidb
+*.svclog
+*.scc
+
+# Chutzpah Test files
+_Chutzpah*
+
+# Visual C++ cache files
+ipch/
+*.aps
+*.ncb
+*.opendb
+*.opensdf
+*.sdf
+*.cachefile
+*.VC.db
+*.VC.VC.opendb
+
+# Visual Studio profiler
+*.psess
+*.vsp
+*.vspx
+*.sap
+
+# Visual Studio Trace Files
+*.e2e
+
+# TFS 2012 Local Workspace
+$tf/
+
+# Guidance Automation Toolkit
+*.gpState
+
+# ReSharper is a .NET coding add-in
+_ReSharper*/
+*.[Rr]e[Ss]harper
+*.DotSettings.user
+
+# TeamCity is a build add-in
+_TeamCity*
+
+# DotCover is a Code Coverage Tool
+*.dotCover
+
+# AxoCover is a Code Coverage Tool
+.axoCover/*
+!.axoCover/settings.json
+
+# Coverlet is a free, cross platform Code Coverage Tool
+coverage*.json
+coverage*.xml
+coverage*.info
+
+# Visual Studio code coverage results
+*.coverage
+*.coveragexml
+
+# NCrunch
+_NCrunch_*
+.*crunch*.local.xml
+nCrunchTemp_*
+
+# MightyMoose
+*.mm.*
+AutoTest.Net/
+
+# Web workbench (sass)
+.sass-cache/
+
+# Installshield output folder
+[Ee]xpress/
+
+# DocProject is a documentation generator add-in
+DocProject/buildhelp/
+DocProject/Help/*.HxT
+DocProject/Help/*.HxC
+DocProject/Help/*.hhc
+DocProject/Help/*.hhk
+DocProject/Help/*.hhp
+DocProject/Help/Html2
+DocProject/Help/html
+
+# Click-Once directory
+publish/
+
+# Publish Web Output
+*.[Pp]ublish.xml
+*.azurePubxml
+# Note: Comment the next line if you want to checkin your web deploy settings,
+# but database connection strings (with potential passwords) will be unencrypted
+*.pubxml
+*.publishproj
+
+# Microsoft Azure Web App publish settings. Comment the next line if you want to
+# checkin your Azure Web App publish settings, but sensitive information contained
+# in these scripts will be unencrypted
+PublishScripts/
+
+# NuGet Packages
+*.nupkg
+# NuGet Symbol Packages
+*.snupkg
+# The packages folder can be ignored because of Package Restore
+**/[Pp]ackages/*
+# except build/, which is used as an MSBuild target.
+!**/[Pp]ackages/build/
+# Uncomment if necessary however generally it will be regenerated when needed
+#!**/[Pp]ackages/repositories.config
+# NuGet v3's project.json files produces more ignorable files
+*.nuget.props
+*.nuget.targets
+
+# Microsoft Azure Build Output
+csx/
+*.build.csdef
+
+# Microsoft Azure Emulator
+ecf/
+rcf/
+
+# Windows Store app package directories and files
+AppPackages/
+BundleArtifacts/
+Package.StoreAssociation.xml
+_pkginfo.txt
+*.appx
+*.appxbundle
+*.appxupload
+
+# Visual Studio cache files
+# files ending in .cache can be ignored
+*.[Cc]ache
+# but keep track of directories ending in .cache
+!?*.[Cc]ache/
+
+# Others
+ClientBin/
+~$*
+*~
+*.dbmdl
+*.dbproj.schemaview
+*.jfm
+*.pfx
+*.publishsettings
+orleans.codegen.cs
+
+# Including strong name files can present a security risk
+# (https://github.com/github/gitignore/pull/2483#issue-259490424)
+#*.snk
+
+# Since there are multiple workflows, uncomment next line to ignore bower_components
+# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
+#bower_components/
+
+# RIA/Silverlight projects
+Generated_Code/
+
+# Backup & report files from converting an old project file
+# to a newer Visual Studio version. Backup files are not needed,
+# because we have git ;-)
+_UpgradeReport_Files/
+Backup*/
+UpgradeLog*.XML
+UpgradeLog*.htm
+ServiceFabricBackup/
+*.rptproj.bak
+
+# SQL Server files
+*.mdf
+*.ldf
+*.ndf
+
+# Business Intelligence projects
+*.rdl.data
+*.bim.layout
+*.bim_*.settings
+*.rptproj.rsuser
+*- [Bb]ackup.rdl
+*- [Bb]ackup ([0-9]).rdl
+*- [Bb]ackup ([0-9][0-9]).rdl
+
+# Microsoft Fakes
+FakesAssemblies/
+
+# GhostDoc plugin setting file
+*.GhostDoc.xml
+
+# Node.js Tools for Visual Studio
+.ntvs_analysis.dat
+node_modules/
+
+# Visual Studio 6 build log
+*.plg
+
+# Visual Studio 6 workspace options file
+*.opt
+
+# Visual Studio 6 auto-generated workspace file (contains which files were open etc.)
+*.vbw
+
+# Visual Studio LightSwitch build output
+**/*.HTMLClient/GeneratedArtifacts
+**/*.DesktopClient/GeneratedArtifacts
+**/*.DesktopClient/ModelManifest.xml
+**/*.Server/GeneratedArtifacts
+**/*.Server/ModelManifest.xml
+_Pvt_Extensions
+
+# Paket dependency manager
+.paket/paket.exe
+paket-files/
+
+# FAKE - F# Make
+.fake/
+
+# CodeRush personal settings
+.cr/personal
+
+# Python Tools for Visual Studio (PTVS)
+__pycache__/
+*.pyc
+
+# Cake - Uncomment if you are using it
+# tools/**
+# !tools/packages.config
+
+# Tabs Studio
+*.tss
+
+# Telerik's JustMock configuration file
+*.jmconfig
+
+# BizTalk build output
+*.btp.cs
+*.btm.cs
+*.odx.cs
+*.xsd.cs
+
+# OpenCover UI analysis results
+OpenCover/
+
+# Azure Stream Analytics local run output
+ASALocalRun/
+
+# MSBuild Binary and Structured Log
+*.binlog
+
+# NVidia Nsight GPU debugger configuration file
+*.nvuser
+
+# MFractors (Xamarin productivity tool) working folder
+.mfractor/
+
+# Local History for Visual Studio
+.localhistory/
+
+# BeatPulse healthcheck temp database
+healthchecksdb
+
+# Backup folder for Package Reference Convert tool in Visual Studio 2017
+MigrationBackup/
+
+# Ionide (cross platform F# VS Code tools) working folder
+.ionide/
+
+# Fody - auto-generated XML schema
+FodyWeavers.xsd
+
+# Python files
+*.pyc
+__pycache__/
+*.egg-info/
+.python-version
+.venv/
+venv/
+dist/
+build/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+*.py[cod]
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..36d431e
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,4 @@
+# Changelog
+
+All notable changes to this project are tracked in GitHub releases. This file
+is maintained automatically by the release workflow.
diff --git a/LICENSE.md b/LICENSE.md
index c6f01c6..52b3834 100644
--- a/LICENSE.md
+++ b/LICENSE.md
@@ -1,660 +1,21 @@
-# GNU AFFERO GENERAL PUBLIC LICENSE
-
-Version 3, 19 November 2007
-
-Copyright (C) 2007 Free Software Foundation, Inc.
-
-
-Everyone is permitted to copy and distribute verbatim copies of this
-license document, but changing it is not allowed.
-
-## Preamble
-
-The GNU Affero General Public License is a free, copyleft license for
-software and other kinds of works, specifically designed to ensure
-cooperation with the community in the case of network server software.
-
-The licenses for most software and other practical works are designed
-to take away your freedom to share and change the works. By contrast,
-our General Public Licenses are intended to guarantee your freedom to
-share and change all versions of a program--to make sure it remains
-free software for all its users.
-
-When we speak of free software, we are referring to freedom, not
-price. Our General Public Licenses are designed to make sure that you
-have the freedom to distribute copies of free software (and charge for
-them if you wish), that you receive source code or can get it if you
-want it, that you can change the software or use pieces of it in new
-free programs, and that you know you can do these things.
-
-Developers that use our General Public Licenses protect your rights
-with two steps: (1) assert copyright on the software, and (2) offer
-you this License which gives you legal permission to copy, distribute
-and/or modify the software.
-
-A secondary benefit of defending all users' freedom is that
-improvements made in alternate versions of the program, if they
-receive widespread use, become available for other developers to
-incorporate. Many developers of free software are heartened and
-encouraged by the resulting cooperation. However, in the case of
-software used on network servers, this result may fail to come about.
-The GNU General Public License permits making a modified version and
-letting the public access it on a server without ever releasing its
-source code to the public.
-
-The GNU Affero General Public License is designed specifically to
-ensure that, in such cases, the modified source code becomes available
-to the community. It requires the operator of a network server to
-provide the source code of the modified version running there to the
-users of that server. Therefore, public use of a modified version, on
-a publicly accessible server, gives the public access to the source
-code of the modified version.
-
-An older license, called the Affero General Public License and
-published by Affero, was designed to accomplish similar goals. This is
-a different license, not a version of the Affero GPL, but Affero has
-released a new version of the Affero GPL which permits relicensing
-under this license.
-
-The precise terms and conditions for copying, distribution and
-modification follow.
-
-## TERMS AND CONDITIONS
-
-### 0. Definitions.
-
-"This License" refers to version 3 of the GNU Affero General Public
-License.
-
-"Copyright" also means copyright-like laws that apply to other kinds
-of works, such as semiconductor masks.
-
-"The Program" refers to any copyrightable work licensed under this
-License. Each licensee is addressed as "you". "Licensees" and
-"recipients" may be individuals or organizations.
-
-To "modify" a work means to copy from or adapt all or part of the work
-in a fashion requiring copyright permission, other than the making of
-an exact copy. The resulting work is called a "modified version" of
-the earlier work or a work "based on" the earlier work.
-
-A "covered work" means either the unmodified Program or a work based
-on the Program.
-
-To "propagate" a work means to do anything with it that, without
-permission, would make you directly or secondarily liable for
-infringement under applicable copyright law, except executing it on a
-computer or modifying a private copy. Propagation includes copying,
-distribution (with or without modification), making available to the
-public, and in some countries other activities as well.
-
-To "convey" a work means any kind of propagation that enables other
-parties to make or receive copies. Mere interaction with a user
-through a computer network, with no transfer of a copy, is not
-conveying.
-
-An interactive user interface displays "Appropriate Legal Notices" to
-the extent that it includes a convenient and prominently visible
-feature that (1) displays an appropriate copyright notice, and (2)
-tells the user that there is no warranty for the work (except to the
-extent that warranties are provided), that licensees may convey the
-work under this License, and how to view a copy of this License. If
-the interface presents a list of user commands or options, such as a
-menu, a prominent item in the list meets this criterion.
-
-### 1. Source Code.
-
-The "source code" for a work means the preferred form of the work for
-making modifications to it. "Object code" means any non-source form of
-a work.
-
-A "Standard Interface" means an interface that either is an official
-standard defined by a recognized standards body, or, in the case of
-interfaces specified for a particular programming language, one that
-is widely used among developers working in that language.
-
-The "System Libraries" of an executable work include anything, other
-than the work as a whole, that (a) is included in the normal form of
-packaging a Major Component, but which is not part of that Major
-Component, and (b) serves only to enable use of the work with that
-Major Component, or to implement a Standard Interface for which an
-implementation is available to the public in source code form. A
-"Major Component", in this context, means a major essential component
-(kernel, window system, and so on) of the specific operating system
-(if any) on which the executable work runs, or a compiler used to
-produce the work, or an object code interpreter used to run it.
-
-The "Corresponding Source" for a work in object code form means all
-the source code needed to generate, install, and (for an executable
-work) run the object code and to modify the work, including scripts to
-control those activities. However, it does not include the work's
-System Libraries, or general-purpose tools or generally available free
-programs which are used unmodified in performing those activities but
-which are not part of the work. For example, Corresponding Source
-includes interface definition files associated with source files for
-the work, and the source code for shared libraries and dynamically
-linked subprograms that the work is specifically designed to require,
-such as by intimate data communication or control flow between those
-subprograms and other parts of the work.
-
-The Corresponding Source need not include anything that users can
-regenerate automatically from other parts of the Corresponding Source.
-
-The Corresponding Source for a work in source code form is that same
-work.
-
-### 2. Basic Permissions.
-
-All rights granted under this License are granted for the term of
-copyright on the Program, and are irrevocable provided the stated
-conditions are met. This License explicitly affirms your unlimited
-permission to run the unmodified Program. The output from running a
-covered work is covered by this License only if the output, given its
-content, constitutes a covered work. This License acknowledges your
-rights of fair use or other equivalent, as provided by copyright law.
-
-You may make, run and propagate covered works that you do not convey,
-without conditions so long as your license otherwise remains in force.
-You may convey covered works to others for the sole purpose of having
-them make modifications exclusively for you, or provide you with
-facilities for running those works, provided that you comply with the
-terms of this License in conveying all material for which you do not
-control copyright. Those thus making or running the covered works for
-you must do so exclusively on your behalf, under your direction and
-control, on terms that prohibit them from making any copies of your
-copyrighted material outside their relationship with you.
-
-Conveying under any other circumstances is permitted solely under the
-conditions stated below. Sublicensing is not allowed; section 10 makes
-it unnecessary.
-
-### 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
-
-No covered work shall be deemed part of an effective technological
-measure under any applicable law fulfilling obligations under article
-11 of the WIPO copyright treaty adopted on 20 December 1996, or
-similar laws prohibiting or restricting circumvention of such
-measures.
-
-When you convey a covered work, you waive any legal power to forbid
-circumvention of technological measures to the extent such
-circumvention is effected by exercising rights under this License with
-respect to the covered work, and you disclaim any intention to limit
-operation or modification of the work as a means of enforcing, against
-the work's users, your or third parties' legal rights to forbid
-circumvention of technological measures.
-
-### 4. Conveying Verbatim Copies.
-
-You may convey verbatim copies of the Program's source code as you
-receive it, in any medium, provided that you conspicuously and
-appropriately publish on each copy an appropriate copyright notice;
-keep intact all notices stating that this License and any
-non-permissive terms added in accord with section 7 apply to the code;
-keep intact all notices of the absence of any warranty; and give all
-recipients a copy of this License along with the Program.
-
-You may charge any price or no price for each copy that you convey,
-and you may offer support or warranty protection for a fee.
-
-### 5. Conveying Modified Source Versions.
-
-You may convey a work based on the Program, or the modifications to
-produce it from the Program, in the form of source code under the
-terms of section 4, provided that you also meet all of these
-conditions:
-
-- a) The work must carry prominent notices stating that you modified
- it, and giving a relevant date.
-- b) The work must carry prominent notices stating that it is
- released under this License and any conditions added under
- section 7. This requirement modifies the requirement in section 4
- to "keep intact all notices".
-- c) You must license the entire work, as a whole, under this
- License to anyone who comes into possession of a copy. This
- License will therefore apply, along with any applicable section 7
- additional terms, to the whole of the work, and all its parts,
- regardless of how they are packaged. This License gives no
- permission to license the work in any other way, but it does not
- invalidate such permission if you have separately received it.
-- d) If the work has interactive user interfaces, each must display
- Appropriate Legal Notices; however, if the Program has interactive
- interfaces that do not display Appropriate Legal Notices, your
- work need not make them do so.
-
-A compilation of a covered work with other separate and independent
-works, which are not by their nature extensions of the covered work,
-and which are not combined with it such as to form a larger program,
-in or on a volume of a storage or distribution medium, is called an
-"aggregate" if the compilation and its resulting copyright are not
-used to limit the access or legal rights of the compilation's users
-beyond what the individual works permit. Inclusion of a covered work
-in an aggregate does not cause this License to apply to the other
-parts of the aggregate.
-
-### 6. Conveying Non-Source Forms.
-
-You may convey a covered work in object code form under the terms of
-sections 4 and 5, provided that you also convey the machine-readable
-Corresponding Source under the terms of this License, in one of these
-ways:
-
-- a) Convey the object code in, or embodied in, a physical product
- (including a physical distribution medium), accompanied by the
- Corresponding Source fixed on a durable physical medium
- customarily used for software interchange.
-- b) Convey the object code in, or embodied in, a physical product
- (including a physical distribution medium), accompanied by a
- written offer, valid for at least three years and valid for as
- long as you offer spare parts or customer support for that product
- model, to give anyone who possesses the object code either (1) a
- copy of the Corresponding Source for all the software in the
- product that is covered by this License, on a durable physical
- medium customarily used for software interchange, for a price no
- more than your reasonable cost of physically performing this
- conveying of source, or (2) access to copy the Corresponding
- Source from a network server at no charge.
-- c) Convey individual copies of the object code with a copy of the
- written offer to provide the Corresponding Source. This
- alternative is allowed only occasionally and noncommercially, and
- only if you received the object code with such an offer, in accord
- with subsection 6b.
-- d) Convey the object code by offering access from a designated
- place (gratis or for a charge), and offer equivalent access to the
- Corresponding Source in the same way through the same place at no
- further charge. You need not require recipients to copy the
- Corresponding Source along with the object code. If the place to
- copy the object code is a network server, the Corresponding Source
- may be on a different server (operated by you or a third party)
- that supports equivalent copying facilities, provided you maintain
- clear directions next to the object code saying where to find the
- Corresponding Source. Regardless of what server hosts the
- Corresponding Source, you remain obligated to ensure that it is
- available for as long as needed to satisfy these requirements.
-- e) Convey the object code using peer-to-peer transmission,
- provided you inform other peers where the object code and
- Corresponding Source of the work are being offered to the general
- public at no charge under subsection 6d.
-
-A separable portion of the object code, whose source code is excluded
-from the Corresponding Source as a System Library, need not be
-included in conveying the object code work.
-
-A "User Product" is either (1) a "consumer product", which means any
-tangible personal property which is normally used for personal,
-family, or household purposes, or (2) anything designed or sold for
-incorporation into a dwelling. In determining whether a product is a
-consumer product, doubtful cases shall be resolved in favor of
-coverage. For a particular product received by a particular user,
-"normally used" refers to a typical or common use of that class of
-product, regardless of the status of the particular user or of the way
-in which the particular user actually uses, or expects or is expected
-to use, the product. A product is a consumer product regardless of
-whether the product has substantial commercial, industrial or
-non-consumer uses, unless such uses represent the only significant
-mode of use of the product.
-
-"Installation Information" for a User Product means any methods,
-procedures, authorization keys, or other information required to
-install and execute modified versions of a covered work in that User
-Product from a modified version of its Corresponding Source. The
-information must suffice to ensure that the continued functioning of
-the modified object code is in no case prevented or interfered with
-solely because modification has been made.
-
-If you convey an object code work under this section in, or with, or
-specifically for use in, a User Product, and the conveying occurs as
-part of a transaction in which the right of possession and use of the
-User Product is transferred to the recipient in perpetuity or for a
-fixed term (regardless of how the transaction is characterized), the
-Corresponding Source conveyed under this section must be accompanied
-by the Installation Information. But this requirement does not apply
-if neither you nor any third party retains the ability to install
-modified object code on the User Product (for example, the work has
-been installed in ROM).
-
-The requirement to provide Installation Information does not include a
-requirement to continue to provide support service, warranty, or
-updates for a work that has been modified or installed by the
-recipient, or for the User Product in which it has been modified or
-installed. Access to a network may be denied when the modification
-itself materially and adversely affects the operation of the network
-or violates the rules and protocols for communication across the
-network.
-
-Corresponding Source conveyed, and Installation Information provided,
-in accord with this section must be in a format that is publicly
-documented (and with an implementation available to the public in
-source code form), and must require no special password or key for
-unpacking, reading or copying.
-
-### 7. Additional Terms.
-
-"Additional permissions" are terms that supplement the terms of this
-License by making exceptions from one or more of its conditions.
-Additional permissions that are applicable to the entire Program shall
-be treated as though they were included in this License, to the extent
-that they are valid under applicable law. If additional permissions
-apply only to part of the Program, that part may be used separately
-under those permissions, but the entire Program remains governed by
-this License without regard to the additional permissions.
-
-When you convey a copy of a covered work, you may at your option
-remove any additional permissions from that copy, or from any part of
-it. (Additional permissions may be written to require their own
-removal in certain cases when you modify the work.) You may place
-additional permissions on material, added by you to a covered work,
-for which you have or can give appropriate copyright permission.
-
-Notwithstanding any other provision of this License, for material you
-add to a covered work, you may (if authorized by the copyright holders
-of that material) supplement the terms of this License with terms:
-
-- a) Disclaiming warranty or limiting liability differently from the
- terms of sections 15 and 16 of this License; or
-- b) Requiring preservation of specified reasonable legal notices or
- author attributions in that material or in the Appropriate Legal
- Notices displayed by works containing it; or
-- c) Prohibiting misrepresentation of the origin of that material,
- or requiring that modified versions of such material be marked in
- reasonable ways as different from the original version; or
-- d) Limiting the use for publicity purposes of names of licensors
- or authors of the material; or
-- e) Declining to grant rights under trademark law for use of some
- trade names, trademarks, or service marks; or
-- f) Requiring indemnification of licensors and authors of that
- material by anyone who conveys the material (or modified versions
- of it) with contractual assumptions of liability to the recipient,
- for any liability that these contractual assumptions directly
- impose on those licensors and authors.
-
-All other non-permissive additional terms are considered "further
-restrictions" within the meaning of section 10. If the Program as you
-received it, or any part of it, contains a notice stating that it is
-governed by this License along with a term that is a further
-restriction, you may remove that term. If a license document contains
-a further restriction but permits relicensing or conveying under this
-License, you may add to a covered work material governed by the terms
-of that license document, provided that the further restriction does
-not survive such relicensing or conveying.
-
-If you add terms to a covered work in accord with this section, you
-must place, in the relevant source files, a statement of the
-additional terms that apply to those files, or a notice indicating
-where to find the applicable terms.
-
-Additional terms, permissive or non-permissive, may be stated in the
-form of a separately written license, or stated as exceptions; the
-above requirements apply either way.
-
-### 8. Termination.
-
-You may not propagate or modify a covered work except as expressly
-provided under this License. Any attempt otherwise to propagate or
-modify it is void, and will automatically terminate your rights under
-this License (including any patent licenses granted under the third
-paragraph of section 11).
-
-However, if you cease all violation of this License, then your license
-from a particular copyright holder is reinstated (a) provisionally,
-unless and until the copyright holder explicitly and finally
-terminates your license, and (b) permanently, if the copyright holder
-fails to notify you of the violation by some reasonable means prior to
-60 days after the cessation.
-
-Moreover, your license from a particular copyright holder is
-reinstated permanently if the copyright holder notifies you of the
-violation by some reasonable means, this is the first time you have
-received notice of violation of this License (for any work) from that
-copyright holder, and you cure the violation prior to 30 days after
-your receipt of the notice.
-
-Termination of your rights under this section does not terminate the
-licenses of parties who have received copies or rights from you under
-this License. If your rights have been terminated and not permanently
-reinstated, you do not qualify to receive new licenses for the same
-material under section 10.
-
-### 9. Acceptance Not Required for Having Copies.
-
-You are not required to accept this License in order to receive or run
-a copy of the Program. Ancillary propagation of a covered work
-occurring solely as a consequence of using peer-to-peer transmission
-to receive a copy likewise does not require acceptance. However,
-nothing other than this License grants you permission to propagate or
-modify any covered work. These actions infringe copyright if you do
-not accept this License. Therefore, by modifying or propagating a
-covered work, you indicate your acceptance of this License to do so.
-
-### 10. Automatic Licensing of Downstream Recipients.
-
-Each time you convey a covered work, the recipient automatically
-receives a license from the original licensors, to run, modify and
-propagate that work, subject to this License. You are not responsible
-for enforcing compliance by third parties with this License.
-
-An "entity transaction" is a transaction transferring control of an
-organization, or substantially all assets of one, or subdividing an
-organization, or merging organizations. If propagation of a covered
-work results from an entity transaction, each party to that
-transaction who receives a copy of the work also receives whatever
-licenses to the work the party's predecessor in interest had or could
-give under the previous paragraph, plus a right to possession of the
-Corresponding Source of the work from the predecessor in interest, if
-the predecessor has it or can get it with reasonable efforts.
-
-You may not impose any further restrictions on the exercise of the
-rights granted or affirmed under this License. For example, you may
-not impose a license fee, royalty, or other charge for exercise of
-rights granted under this License, and you may not initiate litigation
-(including a cross-claim or counterclaim in a lawsuit) alleging that
-any patent claim is infringed by making, using, selling, offering for
-sale, or importing the Program or any portion of it.
-
-### 11. Patents.
-
-A "contributor" is a copyright holder who authorizes use under this
-License of the Program or a work on which the Program is based. The
-work thus licensed is called the contributor's "contributor version".
-
-A contributor's "essential patent claims" are all patent claims owned
-or controlled by the contributor, whether already acquired or
-hereafter acquired, that would be infringed by some manner, permitted
-by this License, of making, using, or selling its contributor version,
-but do not include claims that would be infringed only as a
-consequence of further modification of the contributor version. For
-purposes of this definition, "control" includes the right to grant
-patent sublicenses in a manner consistent with the requirements of
-this License.
-
-Each contributor grants you a non-exclusive, worldwide, royalty-free
-patent license under the contributor's essential patent claims, to
-make, use, sell, offer for sale, import and otherwise run, modify and
-propagate the contents of its contributor version.
-
-In the following three paragraphs, a "patent license" is any express
-agreement or commitment, however denominated, not to enforce a patent
-(such as an express permission to practice a patent or covenant not to
-sue for patent infringement). To "grant" such a patent license to a
-party means to make such an agreement or commitment not to enforce a
-patent against the party.
-
-If you convey a covered work, knowingly relying on a patent license,
-and the Corresponding Source of the work is not available for anyone
-to copy, free of charge and under the terms of this License, through a
-publicly available network server or other readily accessible means,
-then you must either (1) cause the Corresponding Source to be so
-available, or (2) arrange to deprive yourself of the benefit of the
-patent license for this particular work, or (3) arrange, in a manner
-consistent with the requirements of this License, to extend the patent
-license to downstream recipients. "Knowingly relying" means you have
-actual knowledge that, but for the patent license, your conveying the
-covered work in a country, or your recipient's use of the covered work
-in a country, would infringe one or more identifiable patents in that
-country that you have reason to believe are valid.
-
-If, pursuant to or in connection with a single transaction or
-arrangement, you convey, or propagate by procuring conveyance of, a
-covered work, and grant a patent license to some of the parties
-receiving the covered work authorizing them to use, propagate, modify
-or convey a specific copy of the covered work, then the patent license
-you grant is automatically extended to all recipients of the covered
-work and works based on it.
-
-A patent license is "discriminatory" if it does not include within the
-scope of its coverage, prohibits the exercise of, or is conditioned on
-the non-exercise of one or more of the rights that are specifically
-granted under this License. You may not convey a covered work if you
-are a party to an arrangement with a third party that is in the
-business of distributing software, under which you make payment to the
-third party based on the extent of your activity of conveying the
-work, and under which the third party grants, to any of the parties
-who would receive the covered work from you, a discriminatory patent
-license (a) in connection with copies of the covered work conveyed by
-you (or copies made from those copies), or (b) primarily for and in
-connection with specific products or compilations that contain the
-covered work, unless you entered into that arrangement, or that patent
-license was granted, prior to 28 March 2007.
-
-Nothing in this License shall be construed as excluding or limiting
-any implied license or other defenses to infringement that may
-otherwise be available to you under applicable patent law.
-
-### 12. No Surrender of Others' Freedom.
-
-If conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License. If you cannot convey a
-covered work so as to satisfy simultaneously your obligations under
-this License and any other pertinent obligations, then as a
-consequence you may not convey it at all. For example, if you agree to
-terms that obligate you to collect a royalty for further conveying
-from those to whom you convey the Program, the only way you could
-satisfy both those terms and this License would be to refrain entirely
-from conveying the Program.
-
-### 13. Remote Network Interaction; Use with the GNU General Public License.
-
-Notwithstanding any other provision of this License, if you modify the
-Program, your modified version must prominently offer all users
-interacting with it remotely through a computer network (if your
-version supports such interaction) an opportunity to receive the
-Corresponding Source of your version by providing access to the
-Corresponding Source from a network server at no charge, through some
-standard or customary means of facilitating copying of software. This
-Corresponding Source shall include the Corresponding Source for any
-work covered by version 3 of the GNU General Public License that is
-incorporated pursuant to the following paragraph.
-
-Notwithstanding any other provision of this License, you have
-permission to link or combine any covered work with a work licensed
-under version 3 of the GNU General Public License into a single
-combined work, and to convey the resulting work. The terms of this
-License will continue to apply to the part which is the covered work,
-but the work with which it is combined will remain governed by version
-3 of the GNU General Public License.
-
-### 14. Revised Versions of this License.
-
-The Free Software Foundation may publish revised and/or new versions
-of the GNU Affero General Public License from time to time. Such new
-versions will be similar in spirit to the present version, but may
-differ in detail to address new problems or concerns.
-
-Each version is given a distinguishing version number. If the Program
-specifies that a certain numbered version of the GNU Affero General
-Public License "or any later version" applies to it, you have the
-option of following the terms and conditions either of that numbered
-version or of any later version published by the Free Software
-Foundation. If the Program does not specify a version number of the
-GNU Affero General Public License, you may choose any version ever
-published by the Free Software Foundation.
-
-If the Program specifies that a proxy can decide which future versions
-of the GNU Affero General Public License can be used, that proxy's
-public statement of acceptance of a version permanently authorizes you
-to choose that version for the Program.
-
-Later license versions may give you additional or different
-permissions. However, no additional obligations are imposed on any
-author or copyright holder as a result of your choosing to follow a
-later version.
-
-### 15. Disclaimer of Warranty.
-
-THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
-APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
-HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
-WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
-LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
-PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
-DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
-CORRECTION.
-
-### 16. Limitation of Liability.
-
-IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
-CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
-INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
-ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
-NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
-LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM
-TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
-PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
-
-### 17. Interpretation of Sections 15 and 16.
-
-If the disclaimer of warranty and limitation of liability provided
-above cannot be given local legal effect according to their terms,
-reviewing courts shall apply local law that most closely approximates
-an absolute waiver of all civil liability in connection with the
-Program, unless a warranty or assumption of liability accompanies a
-copy of the Program in return for a fee.
-
-END OF TERMS AND CONDITIONS
-
-## How to Apply These Terms to Your New Programs
-
-If you develop a new program, and you want it to be of the greatest
-possible use to the public, the best way to achieve this is to make it
-free software which everyone can redistribute and change under these
-terms.
-
-To do so, attach the following notices to the program. It is safest to
-attach them to the start of each source file to most effectively state
-the exclusion of warranty; and each file should have at least the
-"copyright" line and a pointer to where the full notice is found.
-
-
- Copyright (C)
-
- This program is free software: you can redistribute it and/or modify
- it under the terms of the GNU Affero General Public License as
- published by the Free Software Foundation, either version 3 of the
- License, or (at your option) any later version.
-
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU Affero General Public License for more details.
-
- You should have received a copy of the GNU Affero General Public License
- along with this program. If not, see .
-
-Also add information on how to contact you by electronic and paper
-mail.
-
-If your software can interact with users remotely through a computer
-network, you should also make sure that it provides a way for users to
-get its source. For example, if your program is a web application, its
-interface could display a "Source" link that leads users to an archive
-of the code. There are many ways you could offer source, and different
-solutions will be better for different programs; see section 13 for
-the specific requirements.
-
-You should also get your employer (if you work as a programmer) or
-school, if any, to sign a "copyright disclaimer" for the program, if
-necessary. For more information on this, and how to apply and follow
-the GNU AGPL, see .
+# NEON AI (TM) SOFTWARE, Software Development Kit & Application Development System
+# All trademark and other rights reserved by their respective owners
+# Copyright 2008-2026 Neongecko.com Inc.
+# BSD-3 License
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
+following conditions are met:
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
+disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
+disclaimer in the documentation and/or other materials provided with the distribution.
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products
+derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5bc57ee
--- /dev/null
+++ b/README.md
@@ -0,0 +1,124 @@
+# BrainForge Inference Utilities
+
+Pluggable pipelines for shaping BrainForge LLM requests and responses.
+
+This package defines request/response orchestration that attaches to an
+existing inference workflow. Concrete behavior (ambient context, RAG/MCP
+injection, request history validation, citations, response sanitizing,
+safety guardrails, ...) can be implemented as **steps** that plug into one of
+two pipelines:
+
+- **Request pipeline** — runs before generation and shapes the request:
+ injecting informational context, RAG retrieval for host-selected
+ providers, validating and truncating history, etc.
+- **Response pipeline** — runs after generation and shapes the response:
+ citation rewrite, sanitization, guardrails, etc.
+
+Primary generation stays with the host, between the two pipelines. The host
+keeps the `UserTransaction` from the request pipeline until the response is
+ready. A pipeline step may call an inference endpoint to modify the transaction
+(for example citation rewrite) without the host owning those requests.
+
+Both pipelines operate on a `UserTransaction`, which carries the request,
+response, and two per-side context dicts (`request_step_context` and
+`response_step_context`). Requests and responses use the existing
+`neon-data-models` models (`LLMRequest` / `LLMResponse`).
+
+## Concepts
+
+| Concept | Purpose |
+| --- | --- |
+| `UserTransaction` | The request/response pair plus `request_step_context` / `response_step_context` dicts. The host holds this object across generation. |
+| `BrainForgeClient` | Builds pipelines from config and exposes `run_request_pipeline` / `run_response_pipeline` / `supported_request_context`. |
+| `RequestStep` | Shapes `transaction.request` before generation. Declares supported `request_context` keys/values. |
+| `ResponseStep` | Annotates/rewrites `transaction.response` after generation. |
+| `RequestContextOption` | One `request_context` key a step reads, with optional allowed values for hosts to present. |
+| `RequestPipeline` / `ResponsePipeline` | Run an ordered list of steps over a transaction. |
+| `PipelineConfig` / `StepConfig` | Declarative, ordered step lists (see below). |
+
+## Usage sketch
+
+```python
+client = BrainForgeClient(pipeline_config)
+
+options = await client.supported_request_context()
+# e.g. options["rag_providers"].values, options["conversational"].values
+
+transaction = await client.run_request_pipeline(llm_request)
+# host performs generation using transaction.request
+transaction = await client.run_response_pipeline(transaction, llm_response)
+```
+
+Request steps write `transaction.request_step_context[step.id]`. Response steps write
+`transaction.response_step_context[step.id]` and may *read* the request-step context. Those
+namespaces are independent, so the same step id may exist on both sides
+without colliding. Context is available across generation only because the
+same `UserTransaction` is passed back in; this package does not store it
+between calls.
+
+## Design notes
+
+- **Steps are independently defensive.** There is no dependency graph between
+ steps. A step that needs something it does not find (e.g. a citation step with
+ no retrieved sources) reports itself inapplicable via `applicable()` and is
+ skipped with a logged reason, rather than failing the pipeline.
+- **Ordering is explicit.** Step order is exactly the order declared in
+ configuration; the pipeline does not reorder.
+- **Steps may be repeated.** The same step id may appear more than once in a
+ pipeline, including with different `config`. Each appearance is a separate
+ instance and runs in declared order. The pipeline does not merge or
+ de-duplicate entries.
+- **Steps own their context.** Each side has its own dict keyed by step id.
+ A repeated step on the *same* side shares that key; a step id on the request
+ side does not clash with the same id on the response side. Each step is
+ responsible for how it stores and reads its own data across one or more
+ calls (for example appending to a list instead of overwriting it).
+ Response steps that consume request-step data should read
+ `transaction.request_step_context` and report inapplicable when required
+ context is absent.
+- **Format contracts live together.** Steps that share a parse format
+ (e.g. a citation formatter and the sanitizer that strips it) belong in the
+ same module and should derive from a shared constant so they cannot drift.
+
+## Step plugins
+
+Installed packages advertise steps with setuptools entry points. Request and
+response steps use different groups:
+
+| Pipeline | Entry point group |
+| --- | --- |
+| Request | `brainforge.inference.request_steps` |
+| Response | `brainforge.inference.response_steps` |
+
+Both groups use the step id `author.step_name`:
+
+- `author` is the plugin developer's slug (`acme`, `brainforge`).
+- `step_name` names that one step (`guardrails`, `rag`).
+
+Each part may contain letters, digits, hyphens, and underscores. The class
+`id`, the config `id`, and the context-dict key are that same string.
+
+The same `author.step_name` may be registered once in each group. Each
+pipeline reads only its own group, so the request class and the response class
+stay distinct. Two packages registering the same name in one group is an
+error.
+
+```python
+entry_points={
+ "brainforge.inference.request_steps": [
+ "acme.guardrails=acme_guardrails:GuardrailRequestStep",
+ ],
+ "brainforge.inference.response_steps": [
+ "acme.guardrails=acme_guardrails:GuardrailResponseStep",
+ ],
+}
+```
+
+```yaml
+pipeline:
+ request:
+ - id: acme.guardrails
+ response:
+ - id: acme.guardrails
+```
+
diff --git a/brainforge_inference_utils/__init__.py b/brainforge_inference_utils/__init__.py
new file mode 100644
index 0000000..80bfd1d
--- /dev/null
+++ b/brainforge_inference_utils/__init__.py
@@ -0,0 +1,82 @@
+# NEON AI (TM) SOFTWARE, Software Development Kit & Application Framework
+# All trademark and other rights reserved by their respective owners
+# Copyright 2008-2026 Neongecko.com Inc.
+# Contributors: Daniel McKnight, Richard Leeds, Bohdan Mykhailenko,
+# Dmitry Honcharenko, Mike Gray, Clary Gasper, Charlie Bailey, Ryan Venturi,
+# Roger Wiebe, Pierce Seigne, Sathvika Nadipalli, Guy Daniels, Elon Gasper,
+# Regina Bloomstine, Casimiro Ferreira, Andrii Pernatii, Kirill Hrymailo
+# BSD-3 License
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+# 3. Neither the name of the copyright holder nor the names of its
+# contributors may be used to endorse or promote products derived from this
+# software without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+# OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+"""BrainForge inference pipeline utilities."""
+
+from neon_data_models.models.api.llm import (
+ LLMPersona,
+ LLMRequest,
+ LLMResponse,
+)
+
+from brainforge_inference_utils.version import __version__
+
+from brainforge_inference_utils.client import BrainForgeClient
+from brainforge_inference_utils.config import PipelineConfig, StepConfig
+from brainforge_inference_utils.pipeline import (
+ RequestPipeline,
+ ResponsePipeline,
+ build_pipelines,
+)
+from brainforge_inference_utils.registry import (
+ REQUEST_STEP_ENTRY_POINT,
+ RESPONSE_STEP_ENTRY_POINT,
+)
+from brainforge_inference_utils.steps.base import (
+ RequestStep,
+ RequestContextOption,
+ ResponseStep,
+ Step,
+)
+from brainforge_inference_utils.transaction import UserTransaction
+
+__all__ = [
+ "__version__",
+ "BrainForgeClient",
+ # Request/response models (re-exported from neon-data-models)
+ "LLMRequest",
+ "LLMResponse",
+ "LLMPersona",
+ # Transaction
+ "UserTransaction",
+ # Steps
+ "Step",
+ "RequestStep",
+ "ResponseStep",
+ "RequestContextOption",
+ # Pipelines
+ "RequestPipeline",
+ "ResponsePipeline",
+ "build_pipelines",
+ "REQUEST_STEP_ENTRY_POINT",
+ "RESPONSE_STEP_ENTRY_POINT",
+ # Config
+ "PipelineConfig",
+ "StepConfig",
+]
diff --git a/brainforge_inference_utils/client.py b/brainforge_inference_utils/client.py
new file mode 100644
index 0000000..8f3b737
--- /dev/null
+++ b/brainforge_inference_utils/client.py
@@ -0,0 +1,117 @@
+# NEON AI (TM) SOFTWARE, Software Development Kit & Application Framework
+# All trademark and other rights reserved by their respective owners
+# Copyright 2008-2026 Neongecko.com Inc.
+# Contributors: Daniel McKnight, Richard Leeds, Bohdan Mykhailenko,
+# Dmitry Honcharenko, Mike Gray, Clary Gasper, Charlie Bailey, Ryan Venturi,
+# Roger Wiebe, Pierce Seigne, Sathvika Nadipalli, Guy Daniels, Elon Gasper,
+# Regina Bloomstine, Casimiro Ferreira, Andrii Pernatii, Kirill Hrymailo
+# BSD-3 License
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+# 3. Neither the name of the copyright holder nor the names of its
+# contributors may be used to endorse or promote products derived from this
+# software without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+# OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+"""Configured runner for the request and response pipelines.
+
+`BrainForgeClient` does not call an LLM. The host runs inference between
+`run_request_pipeline` and `run_response_pipeline`, and is responsible for keeping
+the returned `UserTransaction` until the response is ready.
+"""
+
+from __future__ import annotations
+
+from typing import Dict
+
+from neon_data_models.models.api.llm import LLMRequest, LLMResponse
+
+from brainforge_inference_utils.config import PipelineConfig
+from brainforge_inference_utils.pipeline import build_pipelines
+from brainforge_inference_utils.steps.base import RequestContextOption
+from brainforge_inference_utils.transaction import UserTransaction
+
+
+class BrainForgeClient:
+ """Build pipelines from config and run them around host-owned inference."""
+
+ def __init__(self, config: PipelineConfig):
+ self.config = config
+ self.request_pipeline, self.response_pipeline = build_pipelines(config)
+
+ async def supported_request_context(
+ self, timeout: float = 10.0
+ ) -> Dict[str, RequestContextOption]:
+ """
+ Collect `request_context` keys and allowed values from the pipeline.
+
+ The host uses this to populate UI; it does not call MCP itself.
+ Duplicate keys across steps are merged: enumerated values are unioned
+ in first-seen order, and if any declaration is unconstrained
+ (`values is None`) the merged option is unconstrained.
+ """
+ merged: Dict[str, RequestContextOption] = {}
+ for step in (*self.request_pipeline.steps, *self.response_pipeline.steps):
+ for option in await step.supported_request_context(timeout=timeout):
+ _merge_request_context_option(merged, option)
+ return merged
+
+ async def run_request_pipeline(
+ self, request: LLMRequest
+ ) -> UserTransaction:
+ """
+ Shape `request` and collect step context on a new transaction.
+
+ The caller must hold the returned transaction until
+ `run_response_pipeline` (or drop it if the response pipeline is unused).
+ """
+ transaction = UserTransaction(request=request)
+ return await self.request_pipeline.run(transaction)
+
+ async def run_response_pipeline(
+ self, transaction: UserTransaction, response: LLMResponse
+ ) -> UserTransaction:
+ """
+ Attach `response` to `transaction` and run the response pipeline.
+
+ Request-step context is on `transaction.request_step_context`; response steps
+ write to `transaction.response_step_context`. The caller must pass through
+ the transaction from `run_request_pipeline`.
+ """
+ transaction.response = response
+ return await self.response_pipeline.run(transaction)
+
+
+def _merge_request_context_option(
+ merged: Dict[str, RequestContextOption],
+ option: RequestContextOption,
+) -> None:
+ prior = merged.get(option.key)
+ if prior is None:
+ merged[option.key] = option
+ return
+ description = prior.description or option.description
+ if prior.values is None or option.values is None:
+ merged[option.key] = RequestContextOption(
+ option.key, None, description)
+ return
+ values = list(prior.values)
+ for value in option.values:
+ if value not in values:
+ values.append(value)
+ merged[option.key] = RequestContextOption(
+ option.key, values, description)
diff --git a/brainforge_inference_utils/config.py b/brainforge_inference_utils/config.py
new file mode 100644
index 0000000..1aaf391
--- /dev/null
+++ b/brainforge_inference_utils/config.py
@@ -0,0 +1,105 @@
+# NEON AI (TM) SOFTWARE, Software Development Kit & Application Framework
+# All trademark and other rights reserved by their respective owners
+# Copyright 2008-2026 Neongecko.com Inc.
+# Contributors: Daniel McKnight, Richard Leeds, Bohdan Mykhailenko,
+# Dmitry Honcharenko, Mike Gray, Clary Gasper, Charlie Bailey, Ryan Venturi,
+# Roger Wiebe, Pierce Seigne, Sathvika Nadipalli, Guy Daniels, Elon Gasper,
+# Regina Bloomstine, Casimiro Ferreira, Andrii Pernatii, Kirill Hrymailo
+# BSD-3 License
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+# 3. Neither the name of the copyright holder nor the names of its
+# contributors may be used to endorse or promote products derived from this
+# software without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+# OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+"""
+Pipeline configuration schema.
+
+Configuration is two explicitly ordered lists of step entries: `request` and
+`response`. Order is authoritative; the pipeline runs steps in exactly the
+order given and does not reorder. Each entry names a step `id`
+(`author.step_name`, the entry point name) and optionally carries
+step-specific `config`.
+
+Example (YAML)::
+
+ pipeline:
+ request:
+ - id: brainforge.locale
+ config:
+ mcp_url: https://mcp.neonaiservices2.com/mcp
+ default_location: Renton, WA, USA
+ timeout: 5.0
+ - {id: brainforge.rag, config: {mcp_url: https://mcp.neonaiservices2.com/mcp, top_k: 10}}
+ - brainforge.history # last: valid, truncated history
+ response:
+ - id: brainforge.citations
+ config:
+ mcp_url: https://mcp.neonaiservices2.com/mcp
+ openai_url: https://hana.example/brainforge/openai/chat/completions
+
+A host typically loads its own config and hands the `pipeline` section here::
+
+ pipeline_config = PipelineConfig.model_validate(config["pipeline"])
+"""
+
+from __future__ import annotations
+
+from typing import Any, Dict, List
+
+from pydantic import BaseModel, ConfigDict, Field, model_validator
+
+
+class StepConfig(BaseModel):
+ """
+ A single step entry within a pipeline.
+
+ :param id: Step id to resolve and instantiate. This is the entry point
+ name, `author.step_name`.
+ :param enabled: When false, the entry is skipped at build time (a
+ convenient way to turn a step off without deleting its config).
+ :param config: Step-specific configuration passed to the step constructor.
+ """
+
+ model_config = ConfigDict(extra="forbid")
+
+ id: str
+ enabled: bool = True
+ config: Dict[str, Any] = Field(default_factory=dict)
+
+ @model_validator(mode="before")
+ @classmethod
+ def _coerce_shorthand(cls, data: Any) -> Any:
+ """Allow a bare string entry as shorthand for `{id: }`."""
+ if isinstance(data, str):
+ return {"id": data}
+ return data
+
+
+class PipelineConfig(BaseModel):
+ """
+ Ordered step lists for the request and response pipelines.
+
+ :param request: Ordered `RequestStep` entries, run before generation.
+ :param response: Ordered `ResponseStep` entries, run after generation.
+ """
+
+ model_config = ConfigDict(extra="forbid")
+
+ request: List[StepConfig] = Field(default_factory=list)
+ response: List[StepConfig] = Field(default_factory=list)
diff --git a/brainforge_inference_utils/mcp.py b/brainforge_inference_utils/mcp.py
new file mode 100644
index 0000000..3da2f41
--- /dev/null
+++ b/brainforge_inference_utils/mcp.py
@@ -0,0 +1,92 @@
+# NEON AI (TM) SOFTWARE, Software Development Kit & Application Framework
+# All trademark and other rights reserved by their respective owners
+# Copyright 2008-2026 Neongecko.com Inc.
+# Contributors: Daniel McKnight, Richard Leeds, Bohdan Mykhailenko,
+# Dmitry Honcharenko, Mike Gray, Clary Gasper, Charlie Bailey, Ryan Venturi,
+# Roger Wiebe, Pierce Seigne, Sathvika Nadipalli, Guy Daniels, Elon Gasper,
+# Regina Bloomstine, Casimiro Ferreira, Andrii Pernatii, Kirill Hrymailo
+# BSD-3 License
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+# 3. Neither the name of the copyright holder nor the names of its
+# contributors may be used to endorse or promote products derived from this
+# software without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+# OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+"""Generic MCP client helpers shared by pipeline steps."""
+
+from __future__ import annotations
+
+import json
+from contextlib import asynccontextmanager
+from typing import Any, AsyncIterator
+
+from fastmcp import Client as MCPClient
+from fastmcp.client.transports import StreamableHttpTransport
+
+
+@asynccontextmanager
+async def mcp_client(mcp_url: str) -> AsyncIterator[MCPClient]:
+ """
+ Open a short-lived MCP client session for one or more tool calls.
+
+ :param mcp_url: MCP server URL from step configuration.
+ """
+ transport = StreamableHttpTransport(mcp_url)
+ async with MCPClient(transport) as client:
+ yield client
+
+
+def mcp_tool_inner_payload(result: Any) -> dict:
+ """
+ Server tool payload from tools/call structuredContent envelope.
+
+ Newer mcp CallToolResult stores structuredContent as a model field; older
+ stacks put it only in model_extra. Fall back to JSON in text content.
+ """
+ envelope = getattr(result, "structuredContent", None)
+ if not isinstance(envelope, dict):
+ envelope = (getattr(result, "model_extra", None) or {}).get(
+ "structuredContent") or {}
+ inner = envelope.get("result") or {}
+ payload = inner.get("result")
+ if isinstance(payload, dict):
+ return payload
+ content = getattr(result, "content", None) or []
+ if not content:
+ return {}
+ try:
+ parsed = json.loads(content[0].text)
+ except (json.JSONDecodeError, TypeError, AttributeError, IndexError):
+ return {}
+ inner = parsed.get("result") or {}
+ payload = inner.get("result")
+ return payload if isinstance(payload, dict) else {}
+
+
+def mcp_tool_content_parts(tool_result: Any) -> list:
+ """
+ Normalize tools/call handling across fastmcp and raw protocol objects.
+ """
+ if isinstance(tool_result, list):
+ return tool_result
+ content = getattr(tool_result, "content", None)
+ if isinstance(content, list):
+ return content
+ raise TypeError(
+ f"Unexpected MCP tool result {type(tool_result)!r}; "
+ "expected list or .content list")
diff --git a/brainforge_inference_utils/pipeline.py b/brainforge_inference_utils/pipeline.py
new file mode 100644
index 0000000..3927f6f
--- /dev/null
+++ b/brainforge_inference_utils/pipeline.py
@@ -0,0 +1,171 @@
+# NEON AI (TM) SOFTWARE, Software Development Kit & Application Framework
+# All trademark and other rights reserved by their respective owners
+# Copyright 2008-2026 Neongecko.com Inc.
+# Contributors: Daniel McKnight, Richard Leeds, Bohdan Mykhailenko,
+# Dmitry Honcharenko, Mike Gray, Clary Gasper, Charlie Bailey, Ryan Venturi,
+# Roger Wiebe, Pierce Seigne, Sathvika Nadipalli, Guy Daniels, Elon Gasper,
+# Regina Bloomstine, Casimiro Ferreira, Andrii Pernatii, Kirill Hrymailo
+# BSD-3 License
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+# 3. Neither the name of the copyright holder nor the names of its
+# contributors may be used to endorse or promote products derived from this
+# software without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+# OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+"""
+The request and response pipelines.
+
+- `RequestPipeline` runs ordered `RequestStep`s over a `UserTransaction` to shape
+ its request before generation.
+- `ResponsePipeline` runs ordered `ResponseStep`s over a `UserTransaction` to
+ annotate or rewrite its response after generation.
+
+Generation itself is out of scope here: a caller runs the request pipeline,
+performs generation separately to populate `transaction.response`, then runs the
+response pipeline. Steps that are inapplicable to a given transaction are
+skipped (with a logged reason) rather than failing the pipeline.
+"""
+
+from __future__ import annotations
+
+import logging
+from typing import List, Mapping, Sequence, Tuple, Type
+
+from brainforge_inference_utils.config import PipelineConfig
+from brainforge_inference_utils.registry import (
+ REQUEST_STEP_ENTRY_POINT,
+ RESPONSE_STEP_ENTRY_POINT,
+ load_entry_point_steps,
+)
+from brainforge_inference_utils.steps.base import (
+ RequestStep,
+ ResponseStep,
+ Step,
+)
+from brainforge_inference_utils.transaction import UserTransaction
+
+LOG = logging.getLogger(__name__)
+
+
+class RequestPipeline:
+ """
+ Runs `RequestStep`s in order over a transaction's request.
+
+ :param steps: Ordered request steps.
+ """
+
+ def __init__(self, steps: Sequence[RequestStep]):
+ self.steps: List[RequestStep] = list(steps)
+
+ async def run(self, transaction: UserTransaction) -> UserTransaction:
+ """
+ Run every applicable request step, mutating the transaction in place.
+
+ :param transaction: The transaction whose request to shape.
+ :returns: The same `transaction`.
+ """
+ for step in self.steps:
+ reason = step.applicable(transaction)
+ if reason is not None:
+ LOG.debug("Skipping request step %r: %s", step.id, reason)
+ continue
+ await step.process(transaction)
+ return transaction
+
+
+class ResponsePipeline:
+ """
+ Runs `ResponseStep`s in order over a transaction's response.
+
+ :param steps: Ordered response steps.
+ """
+
+ def __init__(self, steps: Sequence[ResponseStep]):
+ self.steps: List[ResponseStep] = list(steps)
+
+ async def run(self, transaction: UserTransaction) -> UserTransaction:
+ """
+ Run every applicable response step, mutating the transaction in place.
+
+ :param transaction: The transaction whose response to shape.
+ :returns: The same `transaction`.
+ """
+ for step in self.steps:
+ reason = step.applicable(transaction)
+ if reason is not None:
+ LOG.debug("Skipping response step %r: %s", step.id, reason)
+ continue
+ await step.process(transaction)
+ return transaction
+
+
+def _resolve_step(stage_id: str,
+ steps: Mapping[str, Type[Step]]) -> Type[Step]:
+ try:
+ return steps[stage_id]
+ except KeyError:
+ raise KeyError(
+ f"No step registered with id {stage_id!r}. "
+ f"Known steps: {sorted(steps)}")
+
+
+def build_pipelines(
+ config: PipelineConfig,
+) -> Tuple[RequestPipeline, ResponsePipeline]:
+ """
+ Instantiate both pipelines from configuration.
+
+ Step classes come from the entry point group for that pipeline
+ (`brainforge.inference.request_steps` or
+ `brainforge.inference.response_steps`). A response step placed in the
+ request list (or vice versa) is absent from that group and fails at
+ build time.
+
+ :param config: Parsed pipeline configuration.
+ :returns: `(request_pipeline, response_pipeline)`.
+ :raises KeyError: If a configured step id is not registered in that
+ pipeline's entry point group.
+ :raises TypeError: If an installed entry point is not the step type for
+ its group.
+ """
+ request_step_classes = load_entry_point_steps(
+ REQUEST_STEP_ENTRY_POINT, RequestStep)
+ response_step_classes = load_entry_point_steps(
+ RESPONSE_STEP_ENTRY_POINT, ResponseStep)
+
+ request_steps: List[RequestStep] = []
+ for entry in config.request:
+ if not entry.enabled:
+ LOG.info("Request step %r disabled by config", entry.id)
+ continue
+ cls = _resolve_step(entry.id, request_step_classes)
+ request_steps.append(cls(entry.config))
+
+ response_steps: List[ResponseStep] = []
+ for entry in config.response:
+ if not entry.enabled:
+ LOG.info("Response step %r disabled by config", entry.id)
+ continue
+ cls = _resolve_step(entry.id, response_step_classes)
+ response_steps.append(cls(entry.config))
+
+ LOG.info("Built request pipeline: %s",
+ [s.id for s in request_steps] or "(empty)")
+ LOG.info("Built response pipeline: %s",
+ [s.id for s in response_steps] or "(empty)")
+ return RequestPipeline(request_steps), ResponsePipeline(response_steps)
diff --git a/brainforge_inference_utils/registry.py b/brainforge_inference_utils/registry.py
new file mode 100644
index 0000000..7cb35b9
--- /dev/null
+++ b/brainforge_inference_utils/registry.py
@@ -0,0 +1,115 @@
+# NEON AI (TM) SOFTWARE, Software Development Kit & Application Framework
+# All trademark and other rights reserved by their respective owners
+# Copyright 2008-2026 Neongecko.com Inc.
+# Contributors: Daniel McKnight, Richard Leeds, Bohdan Mykhailenko,
+# Dmitry Honcharenko, Mike Gray, Clary Gasper, Charlie Bailey, Ryan Venturi,
+# Roger Wiebe, Pierce Seigne, Sathvika Nadipalli, Guy Daniels, Elon Gasper,
+# Regina Bloomstine, Casimiro Ferreira, Andrii Pernatii, Kirill Hrymailo
+# BSD-3 License
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+# 3. Neither the name of the copyright holder nor the names of its
+# contributors may be used to endorse or promote products derived from this
+# software without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+# OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+"""
+Discovery of plugin steps via setuptools entry points.
+
+Request and response steps are registered in separate groups, so the same
+`author.step_name` id can exist on both sides. Every step class comes from
+the entry point group for its pipeline.
+"""
+
+from __future__ import annotations
+
+import logging
+import re
+from importlib.metadata import entry_points
+from typing import Dict, Type
+
+from brainforge_inference_utils.steps.base import Step
+
+LOG = logging.getLogger(__name__)
+
+REQUEST_STEP_ENTRY_POINT = "brainforge.inference.request_steps"
+RESPONSE_STEP_ENTRY_POINT = "brainforge.inference.response_steps"
+
+# author.step_name — letters, digits, hyphens, and underscores in each part.
+STEP_ID_PATTERN = re.compile(r"^[A-Za-z0-9_-]+\.[A-Za-z0-9_-]+$")
+
+
+def _distribution_name(entry_point) -> str:
+ dist = getattr(entry_point, "dist", None)
+ return getattr(dist, "name", None) or "unknown"
+
+
+def load_entry_point_steps(
+ group: str,
+ expected_type: Type[Step],
+) -> Dict[str, Type[Step]]:
+ """
+ Load step classes advertised under `group`.
+
+ Each entry point name must be `author.step_name` and must equal the
+ loaded class's `id`. Each part may contain letters, digits, hyphens, and
+ underscores. Names must be unique within the group. The same name may
+ still be registered under the other pipeline's group.
+
+ :param group: Entry point group to read.
+ :param expected_type: `RequestStep` or `ResponseStep`. Loaded classes must
+ subclass it.
+ :returns: Entry point name -> step class.
+ :raises ValueError: If a name is malformed, duplicated, or differs from
+ the class `id`.
+ :raises TypeError: If a loaded object is not a subclass of `expected_type`.
+ """
+ seen: Dict[str, str] = {}
+ loaded: Dict[str, Type[Step]] = {}
+ for entry_point in entry_points(group=group):
+ dist_name = _distribution_name(entry_point)
+ if not STEP_ID_PATTERN.fullmatch(entry_point.name):
+ raise ValueError(
+ f"Entry point {entry_point.name!r} in {group} from "
+ f"{dist_name} must use the form author.step_name")
+ prior = seen.get(entry_point.name)
+ if prior is not None:
+ raise ValueError(
+ f"Multiple packages register {group} step "
+ f"{entry_point.name!r}: {prior} and {dist_name}")
+ seen[entry_point.name] = dist_name
+
+ try:
+ step_cls = entry_point.load()
+ except Exception as exc:
+ raise ImportError(
+ f"Failed to load step {entry_point.name!r} from {dist_name}"
+ ) from exc
+ if not (isinstance(step_cls, type) and issubclass(step_cls, expected_type)):
+ raise TypeError(
+ f"Entry point {entry_point.name!r} in {group} from {dist_name} "
+ f"loaded {getattr(step_cls, '__name__', step_cls)!r}, which is "
+ f"not a {expected_type.__name__}")
+ if step_cls.id != entry_point.name:
+ raise ValueError(
+ f"Step {step_cls.__name__} from {dist_name} has id "
+ f"{step_cls.id!r}, which does not match entry point "
+ f"{entry_point.name!r}")
+ loaded[entry_point.name] = step_cls
+ LOG.debug("Loaded %s step %r from %s",
+ expected_type.__name__, entry_point.name, dist_name)
+ return loaded
diff --git a/brainforge_inference_utils/steps/__init__.py b/brainforge_inference_utils/steps/__init__.py
new file mode 100644
index 0000000..5156507
--- /dev/null
+++ b/brainforge_inference_utils/steps/__init__.py
@@ -0,0 +1,51 @@
+# NEON AI (TM) SOFTWARE, Software Development Kit & Application Framework
+# All trademark and other rights reserved by their respective owners
+# Copyright 2008-2026 Neongecko.com Inc.
+# Contributors: Daniel McKnight, Richard Leeds, Bohdan Mykhailenko,
+# Dmitry Honcharenko, Mike Gray, Clary Gasper, Charlie Bailey, Ryan Venturi,
+# Roger Wiebe, Pierce Seigne, Sathvika Nadipalli, Guy Daniels, Elon Gasper,
+# Regina Bloomstine, Casimiro Ferreira, Andrii Pernatii, Kirill Hrymailo
+# BSD-3 License
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+# 3. Neither the name of the copyright holder nor the names of its
+# contributors may be used to endorse or promote products derived from this
+# software without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+# OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+"""
+Step base classes.
+
+Concrete steps ship in separate plugins and are discovered from entry points.
+Step ids use `author.step_name`.
+"""
+
+from __future__ import annotations
+
+from brainforge_inference_utils.steps.base import (
+ RequestStep,
+ RequestContextOption,
+ ResponseStep,
+ Step,
+)
+
+__all__ = [
+ "Step",
+ "RequestStep",
+ "ResponseStep",
+ "RequestContextOption",
+]
diff --git a/brainforge_inference_utils/steps/base.py b/brainforge_inference_utils/steps/base.py
new file mode 100644
index 0000000..f642610
--- /dev/null
+++ b/brainforge_inference_utils/steps/base.py
@@ -0,0 +1,194 @@
+# NEON AI (TM) SOFTWARE, Software Development Kit & Application Framework
+# All trademark and other rights reserved by their respective owners
+# Copyright 2008-2026 Neongecko.com Inc.
+# Contributors: Daniel McKnight, Richard Leeds, Bohdan Mykhailenko,
+# Dmitry Honcharenko, Mike Gray, Clary Gasper, Charlie Bailey, Ryan Venturi,
+# Roger Wiebe, Pierce Seigne, Sathvika Nadipalli, Guy Daniels, Elon Gasper,
+# Regina Bloomstine, Casimiro Ferreira, Andrii Pernatii, Kirill Hrymailo
+# BSD-3 License
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+# 3. Neither the name of the copyright holder nor the names of its
+# contributors may be used to endorse or promote products derived from this
+# software without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+# OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+"""
+Step base classes.
+
+Two step types plug into the two pipelines:
+
+- `RequestStep` runs before generation. It shapes the request on the
+ `UserTransaction` (RAG/MCP context, ambient context, request history
+ validation, ...), mutating it in place.
+- `ResponseStep` runs after generation. It shapes the response on the
+ `UserTransaction` (citations, sanitizing, guardrails, ...), mutating it
+ in place.
+
+Both share two conventions:
+
+1. **Defensive, not dependent.** Steps declare no relationships to one another.
+ A step that requires something it does not find reports itself inapplicable
+ from `applicable()` and is skipped (with a logged reason) rather than failing
+ the pipeline. This keeps configuration order the only ordering contract and
+ lets steps be added, removed, or substituted freely.
+
+2. **Shared object, separate namespaces.** Data that must pass between steps
+ travels on the `UserTransaction`, not through a step-to-step interface.
+ Request steps use `transaction.request_step_context`; response steps use
+ `transaction.response_step_context`. Step ids are unique only within one side.
+"""
+
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+from dataclasses import dataclass
+from typing import Any, ClassVar, List, Optional, Sequence
+
+from brainforge_inference_utils.transaction import UserTransaction
+
+
+@dataclass(frozen=True)
+class RequestContextOption:
+ """
+ One `UserTransaction.request_context` key a step reads.
+
+ Hosts collect these from the built pipeline to present the keys and, when
+ known, the values a client may send. `values is None` means the key is
+ supported but unconstrained (any value of the implied type). An empty
+ `values` list means the key is supported but no choices are available
+ right now (for example an empty live catalog).
+ """
+
+ key: str
+ values: Optional[Sequence[Any]] = None
+ description: str = ""
+
+
+class Step(ABC):
+ """
+ Common base for all pipeline steps.
+
+ A step is constructed once, at pipeline build time, with its resolved
+ configuration. The same instance is reused across transactions, so steps
+ should keep per-request state on the `UserTransaction`, not on `self`.
+
+ :cvar id: Unique step identifier used in configuration. Subclasses must set
+ this to a stable, non-empty string. Plugin steps use `author.step_name`
+ and that string must match the entry point name.
+ :cvar request_context_options: Static `request_context` keys this step
+ reads. Override `supported_request_context` when allowed values must be
+ fetched live (for example a provider catalog).
+ """
+
+ id: ClassVar[str] = ""
+ request_context_options: ClassVar[Sequence[RequestContextOption]] = ()
+
+ def __init__(self, config: Optional[dict] = None):
+ """
+ :param config: Step-specific configuration from the pipeline config
+ entry's `config` mapping. Stored as `self.config`.
+ """
+ self.config: dict = dict(config or {})
+
+ def __repr__(self) -> str:
+ return f"<{type(self).__name__} id={self.id!r}>"
+
+ async def supported_request_context(
+ self, timeout: float = 10.0
+ ) -> List[RequestContextOption]:
+ """
+ Return the `request_context` keys this step reads, with allowed values.
+
+ The default copies `request_context_options`. Override when values must
+ be fetched live (for example a provider catalog). `timeout` is unused
+ for static declarations.
+
+ :param timeout: Seconds to wait for a live catalog, when overridden.
+ """
+ return list(self.request_context_options)
+
+
+class RequestStep(Step, ABC):
+ """
+ A step that shapes the request before generation.
+
+ Implementations mutate `transaction.request` in place (selecting a persona,
+ trimming or compacting history, injecting retrieved context, adjusting
+ generation params, ...).
+
+ Steps that read `transaction.request_context` should declare those keys on
+ `request_context_options` (static choices) or override
+ `supported_request_context` (live catalogs). Hosts collect the result via
+ `BrainForgeClient.supported_request_context`.
+ """
+
+ def applicable(self, transaction: UserTransaction) -> Optional[str]:
+ """
+ Decide whether this step should run for the given transaction.
+
+ :param transaction: The current transaction.
+ :returns: `None` to run the step, or a short human-readable reason to
+ skip it (logged). The default runs unconditionally; override to add
+ per-request gating.
+ """
+ return None
+
+ @abstractmethod
+ async def process(self, transaction: UserTransaction) -> None:
+ """
+ Apply this step's effect to the request.
+
+ Only called when `applicable(transaction)` returned `None`.
+ Implementations mutate `transaction` in place and return nothing.
+
+ :param transaction: The transaction whose `request` to shape.
+ """
+ raise NotImplementedError
+
+
+class ResponseStep(Step, ABC):
+ """
+ A step that shapes the generated response.
+
+ Implementations mutate `transaction.response` in place (annotating or
+ rewriting it). They return nothing.
+ """
+
+ def applicable(self, transaction: UserTransaction) -> Optional[str]:
+ """
+ Decide whether this step should run for the given transaction.
+
+ :param transaction: The current transaction (with `response` populated).
+ :returns: `None` to run the step, or a short human-readable reason to
+ skip it (logged). The default runs unconditionally; override to add
+ per-request gating (e.g. skip when there is nothing to annotate).
+ """
+ return None
+
+ @abstractmethod
+ async def process(self, transaction: UserTransaction) -> None:
+ """
+ Apply this step's effect to the response.
+
+ Only called when `applicable(transaction)` returned `None`.
+ Implementations mutate `transaction.response` in place and return
+ nothing.
+
+ :param transaction: The transaction whose `response` to shape.
+ """
+ raise NotImplementedError
diff --git a/brainforge_inference_utils/transaction.py b/brainforge_inference_utils/transaction.py
new file mode 100644
index 0000000..959a742
--- /dev/null
+++ b/brainforge_inference_utils/transaction.py
@@ -0,0 +1,79 @@
+# NEON AI (TM) SOFTWARE, Software Development Kit & Application Framework
+# All trademark and other rights reserved by their respective owners
+# Copyright 2008-2026 Neongecko.com Inc.
+# Contributors: Daniel McKnight, Richard Leeds, Bohdan Mykhailenko,
+# Dmitry Honcharenko, Mike Gray, Clary Gasper, Charlie Bailey, Ryan Venturi,
+# Roger Wiebe, Pierce Seigne, Sathvika Nadipalli, Guy Daniels, Elon Gasper,
+# Regina Bloomstine, Casimiro Ferreira, Andrii Pernatii, Kirill Hrymailo
+# BSD-3 License
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+# 3. Neither the name of the copyright holder nor the names of its
+# contributors may be used to endorse or promote products derived from this
+# software without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+# OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+"""
+The object a pipeline operates on.
+
+`UserTransaction` represents one user request/response cycle. Request steps shape
+its `request` and write `request_step_context`; generation (performed elsewhere)
+populates its `response`; response steps annotate that `response` and write
+`response_step_context`.
+
+The request and response are the existing `neon-data-models` models used across
+the BrainForge stack (HANA, `brainforge-llm-service`), so this package does not
+redefine their shape.
+"""
+
+from __future__ import annotations
+
+from typing import Any, Dict, Optional
+
+from pydantic import BaseModel, Field
+
+from neon_data_models.models.api.llm import LLMRequest, LLMResponse
+
+
+class UserTransaction(BaseModel):
+ """
+ One user request/response cycle as it flows through the pipelines.
+
+ :param request: The request being shaped by the request pipeline.
+ :param response: The generated response, populated after generation and
+ shaped by the response pipeline. `None` until generation completes.
+ :param request_step_context: Transient data written by request steps, keyed by
+ request step id.
+ :param response_step_context: Transient data written by response steps, keyed by
+ response step id.
+ """
+
+ request: LLMRequest = Field(
+ description="The LLM request shaped by the request pipeline")
+ response: Optional[LLMResponse] = Field(
+ default=None,
+ description="The generated response shaped by the response pipeline; "
+ "None until generation completes")
+ request_context: Dict[str, Any] = Field(
+ default_factory=dict,
+ description="Client-provided context read by request steps")
+ request_step_context: Dict[str, Any] = Field(
+ default_factory=dict,
+ description="Request-step context keyed by request step id")
+ response_step_context: Dict[str, Any] = Field(
+ default_factory=dict,
+ description="Response-step context keyed by response step id")
diff --git a/brainforge_inference_utils/version.py b/brainforge_inference_utils/version.py
new file mode 100644
index 0000000..0707f34
--- /dev/null
+++ b/brainforge_inference_utils/version.py
@@ -0,0 +1,31 @@
+# NEON AI (TM) SOFTWARE, Software Development Kit & Application Framework
+# All trademark and other rights reserved by their respective owners
+# Copyright 2008-2026 Neongecko.com Inc.
+# Contributors: Daniel McKnight, Richard Leeds, Bohdan Mykhailenko,
+# Dmitry Honcharenko, Mike Gray, Clary Gasper, Charlie Bailey, Ryan Venturi,
+# Roger Wiebe, Pierce Seigne, Sathvika Nadipalli, Guy Daniels, Elon Gasper,
+# Regina Bloomstine, Casimiro Ferreira, Andrii Pernatii, Kirill Hrymailo
+# BSD-3 License
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+# 3. Neither the name of the copyright holder nor the names of its
+# contributors may be used to endorse or promote products derived from this
+# software without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+# OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+__version__ = "0.0.1a0"
diff --git a/requirements/requirements.txt b/requirements/requirements.txt
new file mode 100644
index 0000000..2cf9e1c
--- /dev/null
+++ b/requirements/requirements.txt
@@ -0,0 +1,4 @@
+pydantic~=2.0
+neon-data-models~=0.0.2,>=0.0.3a8
+fastmcp~=2.3
+requests
diff --git a/requirements/test.txt b/requirements/test.txt
new file mode 100644
index 0000000..0c5b054
--- /dev/null
+++ b/requirements/test.txt
@@ -0,0 +1 @@
+pytest~=8.0
diff --git a/setup.py b/setup.py
new file mode 100644
index 0000000..82ae5c2
--- /dev/null
+++ b/setup.py
@@ -0,0 +1,103 @@
+# NEON AI (TM) SOFTWARE, Software Development Kit & Application Framework
+# All trademark and other rights reserved by their respective owners
+# Copyright 2008-2026 Neongecko.com Inc.
+# Contributors: Daniel McKnight, Richard Leeds, Bohdan Mykhailenko,
+# Dmitry Honcharenko, Mike Gray, Clary Gasper, Charlie Bailey, Ryan Venturi,
+# Roger Wiebe, Pierce Seigne, Sathvika Nadipalli, Guy Daniels, Elon Gasper,
+# Regina Bloomstine, Casimiro Ferreira, Andrii Pernatii, Kirill Hrymailo
+# BSD-3 License
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+# 3. Neither the name of the copyright holder nor the names of its
+# contributors may be used to endorse or promote products derived from this
+# software without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+# OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+from os import getenv, path
+
+from setuptools import find_packages, setup
+
+BASE_PATH = path.abspath(path.dirname(__file__))
+
+
+def get_requirements(requirements_filename: str):
+ requirements_file = path.join(
+ BASE_PATH, "requirements", requirements_filename
+ )
+ with open(requirements_file, "r", encoding="utf-8") as r:
+ requirements = r.readlines()
+ requirements = [
+ r.strip()
+ for r in requirements
+ if r.strip() and not r.strip().startswith("#")
+ ]
+
+ for i in range(0, len(requirements)):
+ r = requirements[i]
+ if "@" in r:
+ parts = [
+ p.lower() if p.strip().startswith("git+http") else p
+ for p in r.split("@")
+ ]
+ r = "@".join(parts)
+ if getenv("GITHUB_TOKEN"):
+ if "github.com" in r:
+ requirements[i] = r.replace(
+ "github.com", f"{getenv('GITHUB_TOKEN')}@github.com"
+ )
+ return requirements
+
+
+with open(path.join(BASE_PATH, "README.md"), "r") as f:
+ long_description = f.read()
+
+with open(
+ path.join(BASE_PATH, "brainforge_inference_utils", "version.py"),
+ "r",
+ encoding="utf-8",
+) as v:
+ for line in v.readlines():
+ if line.startswith("__version__"):
+ if '"' in line:
+ version = line.split('"')[1]
+ else:
+ version = line.split("'")[1]
+
+
+setup(
+ name="brainforge-inference-utils",
+ version=version,
+ description="Pluggable request/response pipelines for BrainForge LLM inference",
+ long_description=long_description,
+ long_description_content_type="text/markdown",
+ url="https://github.com/NeonGeckoCom/brainforge-inference-utils",
+ author="NeonGecko",
+ author_email="developers@neon.ai",
+ license="AGPL-3.0-only",
+ packages=find_packages(),
+ include_package_data=True,
+ install_requires=get_requirements("requirements.txt"),
+ extras_require={
+ "test": get_requirements("test.txt"),
+ },
+ zip_safe=True,
+ classifiers=[
+ "Intended Audience :: Developers",
+ "Programming Language :: Python :: 3",
+ ],
+)
diff --git a/tests/helpers.py b/tests/helpers.py
new file mode 100644
index 0000000..6e9df56
--- /dev/null
+++ b/tests/helpers.py
@@ -0,0 +1,174 @@
+# NEON AI (TM) SOFTWARE, Software Development Kit & Application Framework
+# All trademark and other rights reserved by their respective owners
+# Copyright 2008-2026 Neongecko.com Inc.
+# Contributors: Daniel McKnight, Richard Leeds, Bohdan Mykhailenko,
+# Dmitry Honcharenko, Mike Gray, Clary Gasper, Charlie Bailey, Ryan Venturi,
+# Roger Wiebe, Pierce Seigne, Sathvika Nadipalli, Guy Daniels, Elon Gasper,
+# Regina Bloomstine, Casimiro Ferreira, Andrii Pernatii, Kirill Hrymailo
+# BSD-3 License
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+# 3. Neither the name of the copyright holder nor the names of its
+# contributors may be used to endorse or promote products derived from this
+# software without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+# OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+from types import SimpleNamespace
+from typing import Optional, Type
+
+from neon_data_models.models.api.llm import (
+ LLMPersona,
+ LLMRequest,
+ LLMResponse,
+)
+
+from brainforge_inference_utils.registry import (
+ REQUEST_STEP_ENTRY_POINT,
+ RESPONSE_STEP_ENTRY_POINT,
+)
+from brainforge_inference_utils.steps.base import RequestStep, ResponseStep, Step
+from brainforge_inference_utils.transaction import UserTransaction
+
+
+def make_request(**overrides) -> LLMRequest:
+ values = dict(
+ query="hello",
+ history=[("user", "hi"), ("llm", "hey")],
+ persona=LLMPersona(name="vanilla"),
+ model="demo@1",
+ )
+ values.update(overrides)
+ return LLMRequest(**values)
+
+
+def make_response(text: str = "ok", request: Optional[LLMRequest] = None,
+ **overrides) -> LLMResponse:
+ request = request or make_request()
+ values = dict(
+ response=text,
+ history=list(request.history) + [("user", request.query), ("llm", text)],
+ )
+ values.update(overrides)
+ return LLMResponse(**values)
+
+
+def make_transaction(response: Optional[LLMResponse] = None,
+ **request_overrides) -> UserTransaction:
+ request = make_request(**request_overrides)
+ return UserTransaction(request=request, response=response)
+
+
+class SetMaxHistoryStep(RequestStep):
+ """Request step that writes `config["max_history"]` onto the request."""
+
+ id = "test.set_max_history"
+
+ async def process(self, transaction: UserTransaction) -> None:
+ transaction.request.max_history = self.config["max_history"]
+
+
+class SkipUnlessQueryStep(RequestStep):
+ """Request step skipped unless `request.query` matches `config["query"]`."""
+
+ id = "test.skip_unless_query"
+
+ def applicable(self, transaction: UserTransaction) -> Optional[str]:
+ expected = self.config.get("query")
+ if transaction.request.query != expected:
+ return f"query is not {expected!r}"
+ return None
+
+ async def process(self, transaction: UserTransaction) -> None:
+ transaction.request.max_tokens = self.config.get("max_tokens", 256)
+
+
+class AppendQueryStep(RequestStep):
+ """Request step that appends `config["suffix"]` to `request.query`."""
+
+ id = "test.append_query"
+
+ async def process(self, transaction: UserTransaction) -> None:
+ transaction.request.query += self.config.get("suffix", "")
+
+
+class PrefixResponseStep(ResponseStep):
+ """Response step that prepends `config["prefix"]` to the response."""
+
+ id = "test.prefix_response"
+
+ def applicable(self, transaction: UserTransaction) -> Optional[str]:
+ if transaction.response is None:
+ return "no response"
+ return None
+
+ async def process(self, transaction: UserTransaction) -> None:
+ prefix = self.config.get("prefix", "")
+ transaction.response.response = prefix + transaction.response.response
+
+
+class MutateResponseInPlaceStep(ResponseStep):
+ """Response step that appends `config["suffix"]` to the response."""
+
+ id = "test.mutate_in_place"
+
+ async def process(self, transaction: UserTransaction) -> None:
+ transaction.response.response += self.config.get("suffix", "!")
+
+
+class FakeEntryPoint:
+ """Stand-in for an importlib entry point that loads a step class."""
+
+ def __init__(self, name, cls, dist="test-plugin"):
+ self.name = name
+ self._cls = cls
+ self.dist = SimpleNamespace(name=dist)
+
+ def load(self):
+ return self._cls
+
+
+def entry_points_for(request_points=(), response_points=()):
+ """Return an `entry_points(group=...)` replacement for the two step groups."""
+
+ def fake_entry_points(group):
+ if group == REQUEST_STEP_ENTRY_POINT:
+ return list(request_points)
+ if group == RESPONSE_STEP_ENTRY_POINT:
+ return list(response_points)
+ return []
+
+ return fake_entry_points
+
+
+def entry_points_for_steps(
+ *step_classes: Type[Step],
+ dist: str = "test-plugin",
+):
+ """
+ Advertise `step_classes` on the entry point group matching each base class.
+ """
+ request_points = []
+ response_points = []
+ for cls in step_classes:
+ point = FakeEntryPoint(cls.id, cls, dist=dist)
+ if issubclass(cls, RequestStep):
+ request_points.append(point)
+ elif issubclass(cls, ResponseStep):
+ response_points.append(point)
+ else:
+ raise TypeError(f"{cls} is not a request or response step")
+ return entry_points_for(request_points, response_points)
diff --git a/tests/test_client.py b/tests/test_client.py
new file mode 100644
index 0000000..05181ba
--- /dev/null
+++ b/tests/test_client.py
@@ -0,0 +1,175 @@
+# NEON AI (TM) SOFTWARE, Software Development Kit & Application Framework
+# All trademark and other rights reserved by their respective owners
+# Copyright 2008-2026 Neongecko.com Inc.
+# Contributors: Daniel McKnight, Richard Leeds, Bohdan Mykhailenko,
+# Dmitry Honcharenko, Mike Gray, Clary Gasper, Charlie Bailey, Ryan Venturi,
+# Roger Wiebe, Pierce Seigne, Sathvika Nadipalli, Guy Daniels, Elon Gasper,
+# Regina Bloomstine, Casimiro Ferreira, Andrii Pernatii, Kirill Hrymailo
+# BSD-3 License
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+# 3. Neither the name of the copyright holder nor the names of its
+# contributors may be used to endorse or promote products derived from this
+# software without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+# OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+import unittest
+from unittest.mock import patch
+
+from brainforge_inference_utils.client import BrainForgeClient
+from brainforge_inference_utils.config import PipelineConfig
+from brainforge_inference_utils.steps.base import (
+ RequestStep,
+ RequestContextOption,
+ ResponseStep,
+)
+from brainforge_inference_utils.transaction import UserTransaction
+from helpers import (
+ PrefixResponseStep,
+ entry_points_for_steps,
+ make_request,
+ make_response,
+)
+
+
+class RecordRequestStep(RequestStep):
+ id = "test.record_request"
+
+ async def process(self, transaction: UserTransaction) -> None:
+ transaction.request_step_context[self.id] = self.config["value"]
+
+
+class CatalogStep(RequestStep):
+ id = "test.catalog"
+
+ async def process(self, transaction: UserTransaction) -> None:
+ return None
+
+ async def supported_request_context(self, timeout: float = 10.0):
+ return [
+ RequestContextOption(
+ "rag_providers",
+ list(self.config.get("providers") or []),
+ ),
+ RequestContextOption("location", ["Seattle"]),
+ ]
+
+
+class FlagStep(ResponseStep):
+ id = "test.flag"
+ request_context_options = (
+ RequestContextOption("citations_enabled", (True, False)),
+ RequestContextOption("location"),
+ )
+
+ async def process(self, transaction: UserTransaction) -> None:
+ return None
+
+
+class RecordResponseStep(ResponseStep):
+ id = "test.record_response"
+
+ async def process(self, transaction: UserTransaction) -> None:
+ transaction.response_step_context[self.id] = self.config["value"]
+
+
+class TestBrainForgeClient(unittest.IsolatedAsyncioTestCase):
+ def setUp(self):
+ self._entry_points = patch(
+ "brainforge_inference_utils.registry.entry_points",
+ entry_points_for_steps(
+ RecordRequestStep,
+ CatalogStep,
+ PrefixResponseStep,
+ RecordResponseStep,
+ FlagStep,
+ ),
+ )
+ self._entry_points.start()
+
+ def tearDown(self):
+ self._entry_points.stop()
+
+ def make_client(self):
+ config = PipelineConfig.model_validate({
+ "request": [{
+ "id": "test.record_request",
+ "config": {"value": {"documents": ["one"]}},
+ }],
+ "response": [
+ {
+ "id": "test.prefix_response",
+ "config": {"prefix": "processed: "},
+ },
+ {
+ "id": "test.record_response",
+ "config": {"value": {"citations": [1]}},
+ },
+ ],
+ })
+ return BrainForgeClient(config)
+
+ async def test_run_request_pipeline_returns_transaction_with_context(self):
+ client = self.make_client()
+ request = make_request()
+ transaction = await client.run_request_pipeline(request)
+
+ self.assertIs(transaction.request, request)
+ self.assertIsNone(transaction.response)
+ self.assertEqual(
+ transaction.request_step_context,
+ {"test.record_request": {"documents": ["one"]}},
+ )
+ self.assertEqual(transaction.response_step_context, {})
+
+ async def test_run_response_pipeline_keeps_separate_step_namespaces(self):
+ client = self.make_client()
+ transaction = await client.run_request_pipeline(make_request())
+ response = make_response("answer", transaction.request)
+
+ result = await client.run_response_pipeline(transaction, response)
+
+ self.assertIs(result, transaction)
+ self.assertEqual(transaction.response.response, "processed: answer")
+ self.assertEqual(
+ transaction.request_step_context,
+ {"test.record_request": {"documents": ["one"]}},
+ )
+ self.assertEqual(
+ transaction.response_step_context,
+ {"test.record_response": {"citations": [1]}},
+ )
+
+ async def test_supported_request_context_merges_pipeline_steps(self):
+ config = PipelineConfig.model_validate({
+ "request": [
+ {"id": "test.catalog", "config": {"providers": ["news", "docs"]}},
+ {"id": "test.record_request", "config": {"value": {}}},
+ {"id": "test.catalog", "config": {"providers": ["docs", "web"]}},
+ ],
+ "response": [{"id": "test.flag"}],
+ })
+ client = BrainForgeClient(config)
+
+ options = await client.supported_request_context()
+ self.assertEqual(
+ list(options["rag_providers"].values), ["news", "docs", "web"])
+ self.assertEqual(
+ list(options["citations_enabled"].values), [True, False])
+ self.assertIsNone(options["location"].values)
+ self.assertNotIn("test.record_request", options)
diff --git a/tests/test_config.py b/tests/test_config.py
new file mode 100644
index 0000000..f0b4b62
--- /dev/null
+++ b/tests/test_config.py
@@ -0,0 +1,130 @@
+# NEON AI (TM) SOFTWARE, Software Development Kit & Application Framework
+# All trademark and other rights reserved by their respective owners
+# Copyright 2008-2026 Neongecko.com Inc.
+# Contributors: Daniel McKnight, Richard Leeds, Bohdan Mykhailenko,
+# Dmitry Honcharenko, Mike Gray, Clary Gasper, Charlie Bailey, Ryan Venturi,
+# Roger Wiebe, Pierce Seigne, Sathvika Nadipalli, Guy Daniels, Elon Gasper,
+# Regina Bloomstine, Casimiro Ferreira, Andrii Pernatii, Kirill Hrymailo
+# BSD-3 License
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+# 3. Neither the name of the copyright holder nor the names of its
+# contributors may be used to endorse or promote products derived from this
+# software without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+# OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+import pytest
+from pydantic import ValidationError
+
+from brainforge_inference_utils.config import PipelineConfig, StepConfig
+
+
+class TestStepConfig:
+ def test_shorthand_string_becomes_id(self):
+ parsed = StepConfig.model_validate("persona")
+ assert parsed.id == "persona"
+ assert parsed.enabled is True
+ assert parsed.config == {}
+
+ def test_explicit_mapping(self):
+ parsed = StepConfig.model_validate({
+ "id": "rag",
+ "enabled": False,
+ "config": {"top_k": 10},
+ })
+ assert parsed.id == "rag"
+ assert parsed.enabled is False
+ assert parsed.config == {"top_k": 10}
+
+ def test_missing_id_is_invalid(self):
+ with pytest.raises(ValidationError):
+ StepConfig.model_validate({"config": {"top_k": 1}})
+
+ def test_extra_fields_are_forbidden(self):
+ with pytest.raises(ValidationError):
+ StepConfig.model_validate({"id": "persona", "unknown": True})
+
+ def test_constructor_copies_config(self):
+ payload = {"id": "rag", "config": {"top_k": 3}}
+ parsed = StepConfig.model_validate(payload)
+ payload["config"]["top_k"] = 99
+ assert parsed.config["top_k"] == 3
+
+
+class TestPipelineConfig:
+ def test_defaults_to_empty_lists(self):
+ parsed = PipelineConfig()
+ assert parsed.request == []
+ assert parsed.response == []
+
+ def test_mixed_shorthand_and_mapping_entries(self):
+ parsed = PipelineConfig.model_validate({
+ "request": [
+ "persona",
+ {"id": "rag", "config": {"top_k": 10}},
+ ],
+ "response": [
+ {"id": "citations"},
+ ],
+ })
+ assert [entry.id for entry in parsed.request] == ["persona", "rag"]
+ assert parsed.request[1].config == {"top_k": 10}
+ assert parsed.response[0].id == "citations"
+
+ def test_duplicate_step_ids_are_allowed_with_distinct_configs(self):
+ parsed = PipelineConfig.model_validate({
+ "request": [
+ {"id": "append_query", "config": {"suffix": " A"}},
+ {"id": "append_query", "config": {"suffix": " B"}},
+ ],
+ "response": [
+ {"id": "prefix_response", "config": {"prefix": "["}},
+ {"id": "prefix_response", "config": {"prefix": "<"}},
+ ],
+ })
+ assert [entry.id for entry in parsed.request] == [
+ "append_query",
+ "append_query",
+ ]
+ assert [entry.config for entry in parsed.request] == [
+ {"suffix": " A"},
+ {"suffix": " B"},
+ ]
+ assert [entry.config["prefix"] for entry in parsed.response] == [
+ "[",
+ "<",
+ ]
+
+ def test_duplicate_identical_entries_are_allowed(self):
+ parsed = PipelineConfig.model_validate({
+ "request": ["sanitize", "sanitize"],
+ })
+ assert [entry.id for entry in parsed.request] == ["sanitize", "sanitize"]
+
+ def test_empty_lists_are_valid(self):
+ parsed = PipelineConfig.model_validate({"request": [], "response": []})
+ assert parsed.request == []
+ assert parsed.response == []
+
+ def test_extra_fields_are_forbidden(self):
+ with pytest.raises(ValidationError):
+ PipelineConfig.model_validate({"request": [], "chunk": []})
+
+ def test_invalid_entry_type_is_rejected(self):
+ with pytest.raises(ValidationError):
+ PipelineConfig.model_validate({"request": [123]})
diff --git a/tests/test_mcp.py b/tests/test_mcp.py
new file mode 100644
index 0000000..c585bc1
--- /dev/null
+++ b/tests/test_mcp.py
@@ -0,0 +1,64 @@
+# NEON AI (TM) SOFTWARE, Software Development Kit & Application Framework
+# All trademark and other rights reserved by their respective owners
+# Copyright 2008-2026 Neongecko.com Inc.
+# Contributors: Daniel McKnight, Richard Leeds, Bohdan Mykhailenko,
+# Dmitry Honcharenko, Mike Gray, Clary Gasper, Charlie Bailey, Ryan Venturi,
+# Roger Wiebe, Pierce Seigne, Sathvika Nadipalli, Guy Daniels, Elon Gasper,
+# Regina Bloomstine, Casimiro Ferreira, Andrii Pernatii, Kirill Hrymailo
+# BSD-3 License
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+# 3. Neither the name of the copyright holder nor the names of its
+# contributors may be used to endorse or promote products derived from this
+# software without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+# OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+import json
+import unittest
+from types import SimpleNamespace
+
+from brainforge_inference_utils.mcp import (
+ mcp_tool_content_parts,
+ mcp_tool_inner_payload,
+)
+
+
+class TestMcpToolHelpers(unittest.TestCase):
+ def test_inner_payload_from_structured_content(self):
+ result = SimpleNamespace(
+ structuredContent={"result": {"result": {"now": "Monday"}}},
+ content=[],
+ )
+ self.assertEqual(mcp_tool_inner_payload(result), {"now": "Monday"})
+
+ def test_inner_payload_from_text_content(self):
+ payload = {"result": {"result": {"temp": 60}}}
+ result = SimpleNamespace(
+ structuredContent=None,
+ content=[SimpleNamespace(text=json.dumps(payload))],
+ )
+ self.assertEqual(mcp_tool_inner_payload(result), {"temp": 60})
+
+ def test_content_parts_accepts_list(self):
+ parts = [{"type": "text", "text": "hello"}]
+ self.assertEqual(mcp_tool_content_parts(parts), parts)
+
+ def test_content_parts_accepts_result_object(self):
+ parts = [{"type": "text", "text": "hello"}]
+ result = SimpleNamespace(content=parts)
+ self.assertEqual(mcp_tool_content_parts(result), parts)
diff --git a/tests/test_pipeline.py b/tests/test_pipeline.py
new file mode 100644
index 0000000..1073e13
--- /dev/null
+++ b/tests/test_pipeline.py
@@ -0,0 +1,236 @@
+# NEON AI (TM) SOFTWARE, Software Development Kit & Application Framework
+# All trademark and other rights reserved by their respective owners
+# Copyright 2008-2026 Neongecko.com Inc.
+# Contributors: Daniel McKnight, Richard Leeds, Bohdan Mykhailenko,
+# Dmitry Honcharenko, Mike Gray, Clary Gasper, Charlie Bailey, Ryan Venturi,
+# Roger Wiebe, Pierce Seigne, Sathvika Nadipalli, Guy Daniels, Elon Gasper,
+# Regina Bloomstine, Casimiro Ferreira, Andrii Pernatii, Kirill Hrymailo
+# BSD-3 License
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+# 3. Neither the name of the copyright holder nor the names of its
+# contributors may be used to endorse or promote products derived from this
+# software without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+# OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+import unittest
+from unittest.mock import patch
+
+import pytest
+
+from brainforge_inference_utils.config import PipelineConfig
+from brainforge_inference_utils.pipeline import (
+ RequestPipeline,
+ ResponsePipeline,
+ build_pipelines,
+)
+from helpers import (
+ AppendQueryStep,
+ MutateResponseInPlaceStep,
+ PrefixResponseStep,
+ SetMaxHistoryStep,
+ SkipUnlessQueryStep,
+ entry_points_for_steps,
+ make_response,
+ make_transaction,
+)
+
+
+def _patch_test_steps(monkeypatch):
+ monkeypatch.setattr(
+ "brainforge_inference_utils.registry.entry_points",
+ entry_points_for_steps(
+ AppendQueryStep,
+ SkipUnlessQueryStep,
+ PrefixResponseStep,
+ MutateResponseInPlaceStep,
+ ),
+ )
+
+
+class TestBuildPipelines:
+ def test_empty_config_builds_empty_pipelines(self, monkeypatch):
+ _patch_test_steps(monkeypatch)
+ request_pipeline, response_pipeline = build_pipelines(PipelineConfig())
+ assert request_pipeline.steps == []
+ assert response_pipeline.steps == []
+
+ def test_unregistered_id_raises(self, monkeypatch):
+ _patch_test_steps(monkeypatch)
+ with pytest.raises(KeyError, match="test.missing"):
+ build_pipelines(PipelineConfig.model_validate({
+ "request": ["test.missing"],
+ }))
+
+ def test_unknown_id_lists_known_steps(self, monkeypatch):
+ _patch_test_steps(monkeypatch)
+ with pytest.raises(KeyError, match="test.append_query"):
+ build_pipelines(
+ PipelineConfig.model_validate({"request": ["test.missing"]}),
+ )
+
+ def test_disabled_steps_are_omitted(self, monkeypatch):
+ _patch_test_steps(monkeypatch)
+ request_pipeline, response_pipeline = build_pipelines(
+ PipelineConfig.model_validate({
+ "request": [
+ {"id": "test.append_query", "enabled": False,
+ "config": {"suffix": " skipped"}},
+ {"id": "test.append_query", "config": {"suffix": " kept"}},
+ ],
+ "response": [
+ {"id": "test.prefix_response", "enabled": False,
+ "config": {"prefix": "X"}},
+ ],
+ }),
+ )
+ assert len(request_pipeline.steps) == 1
+ assert request_pipeline.steps[0].config == {"suffix": " kept"}
+ assert response_pipeline.steps == []
+
+ def test_response_step_id_is_unknown_on_the_request_pipeline(
+ self, monkeypatch):
+ _patch_test_steps(monkeypatch)
+ with pytest.raises(KeyError, match="test.prefix_response"):
+ build_pipelines(
+ PipelineConfig.model_validate({
+ "request": ["test.prefix_response"]}),
+ )
+
+ def test_request_step_id_is_unknown_on_the_response_pipeline(
+ self, monkeypatch):
+ _patch_test_steps(monkeypatch)
+ with pytest.raises(KeyError, match="test.append_query"):
+ build_pipelines(
+ PipelineConfig.model_validate(
+ {"response": ["test.append_query"]}),
+ )
+
+ def test_duplicate_ids_instantiate_independent_instances(self, monkeypatch):
+ _patch_test_steps(monkeypatch)
+ request_pipeline, response_pipeline = build_pipelines(
+ PipelineConfig.model_validate({
+ "request": [
+ {"id": "test.append_query", "config": {"suffix": " A"}},
+ {"id": "test.append_query", "config": {"suffix": " B"}},
+ ],
+ "response": [
+ {"id": "test.prefix_response", "config": {"prefix": "["}},
+ {"id": "test.prefix_response", "config": {"prefix": "<"}},
+ ],
+ }),
+ )
+ assert len(request_pipeline.steps) == 2
+ assert request_pipeline.steps[0] is not request_pipeline.steps[1]
+ assert [type(step) for step in request_pipeline.steps] == [
+ AppendQueryStep,
+ AppendQueryStep,
+ ]
+ assert [step.config for step in request_pipeline.steps] == [
+ {"suffix": " A"},
+ {"suffix": " B"},
+ ]
+ assert [step.config["prefix"] for step in response_pipeline.steps] == [
+ "[",
+ "<",
+ ]
+
+
+class TestPipelineRun(unittest.IsolatedAsyncioTestCase):
+ async def test_request_steps_run_in_declared_order(self):
+ pipeline = RequestPipeline([
+ AppendQueryStep({"suffix": " A"}),
+ AppendQueryStep({"suffix": " B"}),
+ ])
+ transaction = make_transaction(query="hello")
+ result = await pipeline.run(transaction)
+ assert result is transaction
+ assert transaction.request.query == "hello A B"
+
+ async def test_inapplicable_request_step_is_skipped(self):
+ pipeline = RequestPipeline([
+ SkipUnlessQueryStep({"query": "other", "max_tokens": 64}),
+ SetMaxHistoryStep({"max_history": 7}),
+ ])
+ transaction = make_transaction(query="hello", max_history=2)
+ await pipeline.run(transaction)
+ assert transaction.request.max_tokens == 512
+ assert transaction.request.max_history == 7
+
+ async def test_response_steps_run_in_declared_order(self):
+ pipeline = ResponsePipeline([
+ PrefixResponseStep({"prefix": "["}),
+ PrefixResponseStep({"prefix": "<"}),
+ ])
+ transaction = make_transaction()
+ transaction.response = make_response("ok", transaction.request)
+ await pipeline.run(transaction)
+ assert transaction.response.response == "<[ok"
+
+ async def test_response_steps_mutate_the_same_response(self):
+ pipeline = ResponsePipeline([
+ MutateResponseInPlaceStep({"suffix": "!"}),
+ PrefixResponseStep({"prefix": ">"}),
+ ])
+ transaction = make_transaction()
+ transaction.response = make_response("ok", transaction.request)
+ await pipeline.run(transaction)
+ assert transaction.response.response == ">ok!"
+
+ async def test_inapplicable_response_step_is_skipped(self):
+ pipeline = ResponsePipeline([
+ PrefixResponseStep({"prefix": "["}),
+ ])
+ transaction = make_transaction()
+ assert transaction.response is None
+ await pipeline.run(transaction)
+ assert transaction.response is None
+
+ async def test_build_then_run_duplicate_configured_steps(self):
+ with patch(
+ "brainforge_inference_utils.registry.entry_points",
+ entry_points_for_steps(
+ AppendQueryStep,
+ SkipUnlessQueryStep,
+ PrefixResponseStep,
+ MutateResponseInPlaceStep,
+ ),
+ ):
+ request_pipeline, response_pipeline = build_pipelines(
+ PipelineConfig.model_validate({
+ "request": [
+ {"id": "test.append_query", "config": {"suffix": " A"}},
+ {"id": "test.skip_unless_query",
+ "config": {"query": "nope", "max_tokens": 64}},
+ {"id": "test.append_query", "config": {"suffix": " B"}},
+ ],
+ "response": [
+ {"id": "test.prefix_response", "config": {"prefix": "["}},
+ {"id": "test.mutate_in_place", "config": {"suffix": "!"}},
+ {"id": "test.prefix_response", "config": {"prefix": "<"}},
+ ],
+ }),
+ )
+ transaction = make_transaction(query="hello")
+ await request_pipeline.run(transaction)
+ assert transaction.request.query == "hello A B"
+ assert transaction.request.max_tokens == 512
+
+ transaction.response = make_response("ok", transaction.request)
+ await response_pipeline.run(transaction)
+ assert transaction.response.response == "<[ok!"
diff --git a/tests/test_registry.py b/tests/test_registry.py
new file mode 100644
index 0000000..ab5d1a0
--- /dev/null
+++ b/tests/test_registry.py
@@ -0,0 +1,156 @@
+# NEON AI (TM) SOFTWARE, Software Development Kit & Application Framework
+# All trademark and other rights reserved by their respective owners
+# Copyright 2008-2026 Neongecko.com Inc.
+# Contributors: Daniel McKnight, Richard Leeds, Bohdan Mykhailenko,
+# Dmitry Honcharenko, Mike Gray, Clary Gasper, Charlie Bailey, Ryan Venturi,
+# Roger Wiebe, Pierce Seigne, Sathvika Nadipalli, Guy Daniels, Elon Gasper,
+# Regina Bloomstine, Casimiro Ferreira, Andrii Pernatii, Kirill Hrymailo
+# BSD-3 License
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+# 3. Neither the name of the copyright holder nor the names of its
+# contributors may be used to endorse or promote products derived from this
+# software without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+# OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+import pytest
+
+from brainforge_inference_utils.config import PipelineConfig
+from brainforge_inference_utils.pipeline import build_pipelines
+from brainforge_inference_utils.registry import (
+ REQUEST_STEP_ENTRY_POINT,
+ RESPONSE_STEP_ENTRY_POINT,
+ load_entry_point_steps,
+)
+from brainforge_inference_utils.steps.base import RequestStep, ResponseStep
+from helpers import FakeEntryPoint, entry_points_for
+
+
+class AcmeRequestGuard(RequestStep):
+ id = "acme.guard"
+
+ async def process(self, transaction):
+ return None
+
+
+class AcmeResponseGuard(ResponseStep):
+ id = "acme.guard"
+
+ async def process(self, transaction):
+ return None
+
+
+class MismatchedId(RequestStep):
+ id = "acme.other"
+
+ async def process(self, transaction):
+ return None
+
+
+def test_same_author_step_name_loads_from_both_groups(monkeypatch):
+ monkeypatch.setattr(
+ "brainforge_inference_utils.registry.entry_points",
+ entry_points_for(
+ [FakeEntryPoint("acme.guard", AcmeRequestGuard)],
+ [FakeEntryPoint("acme.guard", AcmeResponseGuard, dist="acme-plugin")],
+ ),
+ )
+
+ request_steps = load_entry_point_steps(
+ REQUEST_STEP_ENTRY_POINT, RequestStep)
+ response_steps = load_entry_point_steps(
+ RESPONSE_STEP_ENTRY_POINT, ResponseStep)
+
+ assert request_steps["acme.guard"] is AcmeRequestGuard
+ assert response_steps["acme.guard"] is AcmeResponseGuard
+
+
+def test_build_pipelines_resolves_entry_point_steps(monkeypatch):
+ monkeypatch.setattr(
+ "brainforge_inference_utils.registry.entry_points",
+ entry_points_for(
+ [FakeEntryPoint("acme.guard", AcmeRequestGuard)],
+ [FakeEntryPoint("acme.guard", AcmeResponseGuard)],
+ ),
+ )
+
+ request_pipeline, response_pipeline = build_pipelines(
+ PipelineConfig.model_validate({
+ "request": ["acme.guard"],
+ "response": ["acme.guard"],
+ }))
+
+ assert [step.id for step in request_pipeline.steps] == ["acme.guard"]
+ assert [step.id for step in response_pipeline.steps] == ["acme.guard"]
+ assert type(request_pipeline.steps[0]) is AcmeRequestGuard
+ assert type(response_pipeline.steps[0]) is AcmeResponseGuard
+
+
+def test_entry_point_name_allows_alphanumerics_hyphen_and_underscore(monkeypatch):
+ class MixedName(RequestStep):
+ id = "Acme-corp.step_name-2"
+
+ async def process(self, transaction):
+ return None
+
+ monkeypatch.setattr(
+ "brainforge_inference_utils.registry.entry_points",
+ entry_points_for([FakeEntryPoint(MixedName.id, MixedName)]),
+ )
+ loaded = load_entry_point_steps(REQUEST_STEP_ENTRY_POINT, RequestStep)
+ assert loaded[MixedName.id] is MixedName
+
+
+def test_entry_point_name_must_be_author_step_name(monkeypatch):
+ monkeypatch.setattr(
+ "brainforge_inference_utils.registry.entry_points",
+ entry_points_for([FakeEntryPoint("guardrails", AcmeRequestGuard)]),
+ )
+ with pytest.raises(ValueError, match="author.step_name"):
+ load_entry_point_steps(REQUEST_STEP_ENTRY_POINT, RequestStep)
+
+
+def test_duplicate_name_in_one_group_names_both_packages(monkeypatch):
+ monkeypatch.setattr(
+ "brainforge_inference_utils.registry.entry_points",
+ entry_points_for([
+ FakeEntryPoint("acme.guard", AcmeRequestGuard, dist="acme-a"),
+ FakeEntryPoint("acme.guard", AcmeRequestGuard, dist="acme-b"),
+ ]),
+ )
+ with pytest.raises(ValueError, match="acme-a and acme-b"):
+ load_entry_point_steps(REQUEST_STEP_ENTRY_POINT, RequestStep)
+
+
+def test_class_id_must_match_entry_point_name(monkeypatch):
+ monkeypatch.setattr(
+ "brainforge_inference_utils.registry.entry_points",
+ entry_points_for([FakeEntryPoint("acme.guard", MismatchedId)]),
+ )
+ with pytest.raises(ValueError, match="does not match entry point"):
+ load_entry_point_steps(REQUEST_STEP_ENTRY_POINT, RequestStep)
+
+
+def test_response_class_in_request_group_raises(monkeypatch):
+ monkeypatch.setattr(
+ "brainforge_inference_utils.registry.entry_points",
+ entry_points_for([FakeEntryPoint("acme.guard", AcmeResponseGuard)]),
+ )
+ with pytest.raises(TypeError, match="not a RequestStep"):
+ load_entry_point_steps(REQUEST_STEP_ENTRY_POINT, RequestStep)
+
diff --git a/tests/test_steps.py b/tests/test_steps.py
new file mode 100644
index 0000000..37c57be
--- /dev/null
+++ b/tests/test_steps.py
@@ -0,0 +1,80 @@
+# NEON AI (TM) SOFTWARE, Software Development Kit & Application Framework
+# All trademark and other rights reserved by their respective owners
+# Copyright 2008-2026 Neongecko.com Inc.
+# Contributors: Daniel McKnight, Richard Leeds, Bohdan Mykhailenko,
+# Dmitry Honcharenko, Mike Gray, Clary Gasper, Charlie Bailey, Ryan Venturi,
+# Roger Wiebe, Pierce Seigne, Sathvika Nadipalli, Guy Daniels, Elon Gasper,
+# Regina Bloomstine, Casimiro Ferreira, Andrii Pernatii, Kirill Hrymailo
+# BSD-3 License
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+# 3. Neither the name of the copyright holder nor the names of its
+# contributors may be used to endorse or promote products derived from this
+# software without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+# OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+from abc import ABC
+
+import pytest
+
+from brainforge_inference_utils.steps.base import RequestStep, ResponseStep
+from helpers import (
+ AppendQueryStep,
+ make_transaction,
+)
+
+
+class TestStepBase:
+ def test_config_defaults_to_empty_dict(self):
+ step = AppendQueryStep()
+ assert step.config == {}
+
+ def test_none_config_defaults_to_empty_dict(self):
+ step = AppendQueryStep(None)
+ assert step.config == {}
+
+ def test_constructor_copies_config(self):
+ payload = {"suffix": "!"}
+ step = AppendQueryStep(payload)
+ payload["suffix"] = "?"
+ assert step.config["suffix"] == "!"
+
+ def test_repr_includes_class_and_id(self):
+ step = AppendQueryStep()
+ assert repr(step) == ""
+
+ def test_default_request_context_options_are_empty(self):
+ assert list(AppendQueryStep().request_context_options) == []
+
+ def test_default_applicable_runs_unconditionally(self):
+ class DefaultResponse(ResponseStep):
+ id = "default_response"
+
+ async def process(self, transaction):
+ return None
+
+ assert AppendQueryStep().applicable(make_transaction()) is None
+ assert DefaultResponse().applicable(make_transaction()) is None
+
+ def test_abstract_bases_cannot_be_instantiated(self):
+ assert issubclass(RequestStep, ABC)
+ assert issubclass(ResponseStep, ABC)
+ with pytest.raises(TypeError):
+ RequestStep()
+ with pytest.raises(TypeError):
+ ResponseStep()
diff --git a/tests/test_transaction.py b/tests/test_transaction.py
new file mode 100644
index 0000000..b9b004a
--- /dev/null
+++ b/tests/test_transaction.py
@@ -0,0 +1,74 @@
+# NEON AI (TM) SOFTWARE, Software Development Kit & Application Framework
+# All trademark and other rights reserved by their respective owners
+# Copyright 2008-2026 Neongecko.com Inc.
+# Contributors: Daniel McKnight, Richard Leeds, Bohdan Mykhailenko,
+# Dmitry Honcharenko, Mike Gray, Clary Gasper, Charlie Bailey, Ryan Venturi,
+# Roger Wiebe, Pierce Seigne, Sathvika Nadipalli, Guy Daniels, Elon Gasper,
+# Regina Bloomstine, Casimiro Ferreira, Andrii Pernatii, Kirill Hrymailo
+# BSD-3 License
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+# 3. Neither the name of the copyright holder nor the names of its
+# contributors may be used to endorse or promote products derived from this
+# software without specific prior written permission.
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+# OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+# LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+from pydantic import ValidationError
+
+from brainforge_inference_utils.transaction import UserTransaction
+from helpers import make_request, make_response
+
+
+class TestUserTransaction:
+ def test_response_defaults_to_none(self):
+ transaction = UserTransaction(request=make_request())
+ assert transaction.response is None
+
+ def test_request_and_response_round_trip(self):
+ request = make_request(query="ping")
+ response = make_response("pong", request=request)
+ transaction = UserTransaction(request=request, response=response)
+ assert transaction.request.query == "ping"
+ assert transaction.response.response == "pong"
+
+ def test_missing_request_is_invalid(self):
+ try:
+ UserTransaction()
+ except ValidationError:
+ return
+ raise AssertionError("expected ValidationError for missing request")
+
+ def test_request_can_be_mutated_in_place(self):
+ transaction = UserTransaction(request=make_request(max_history=2))
+ transaction.request.max_history = 5
+ assert transaction.request.max_history == 5
+
+ def test_pipeline_context_defaults_to_independent_dicts(self):
+ first = UserTransaction(request=make_request())
+ second = UserTransaction(request=make_request())
+ first.request_step_context["rag"] = {"documents": ["document"]}
+ first.response_step_context["citations"] = {"markers": [1]}
+ assert second.request_step_context == {}
+ assert second.response_step_context == {}
+
+ def test_request_and_response_step_ids_do_not_share_a_namespace(self):
+ transaction = UserTransaction(request=make_request())
+ transaction.request_step_context["shared_id"] = {"from": "request"}
+ transaction.response_step_context["shared_id"] = {"from": "response"}
+ assert transaction.request_step_context["shared_id"] == {"from": "request"}
+ assert transaction.response_step_context["shared_id"] == {"from": "response"}