foobara-agent-backed-command 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 282e1d35799a4c8226d1d381689f21a09450e4533c0ec3cdd1a52daabe2565e1
+  data.tar.gz: d1eeb6e39f5518f5e9800d8e9c010cf5e4a3607aa533f29c9a2949fa52da9eb5
+SHA512:
+  metadata.gz: f8a4237ef3f621ab8c854a9f9f2f89f3021ccf6ea4679dcbbeba59237e55572e5d1c7221a6c483fd80ddd2556a4534572fbc69d603b25beb51c5f1587d2433e5
+  data.tar.gz: dc5baf5bd4cd96fe08ad0294b45561c954e8cadef331e98b86e426d91986da4a637c1108777d8784e214de7492a6ad4f5ada7295d6cd6d5bd0f801d066efa7df

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## [0.0.1] - 2025-07-03
+
+- Initial release
+
+## [0.0.0] - 2025-06-22
+
+- Project birth

data/LICENSE-MPL-2.0.txt

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

data/LICENSE.txt

@@ -0,0 +1,9 @@
+This project is licensed under the MPL-2.0 license.
+
+
+  MPL-2.0 License: LICENSE-MPL-2.0.txt or https://www.mozilla.org/MPL/2.0/
+
+
+This is equivalent to the following SPDX License Expression: MPL-2.0
+
+Copyright (c) 2025 Miles Georgi

data/README.md

@@ -0,0 +1,275 @@
+# Foobara::AgentBackedCommand
+
+Allows a quick, easy way to have a command's execute method handled by a Foobara::Agent. Similar to
+the Foobara::LlmBackedCommand, you can just specify whatever parts of the command's anatomy other
+than the execute method, and it will be handled by the Agent.
+
+## Installation
+
+Typical stuff: add `gem "foobara-agent-backed-command"` to your Gemfile or .gemspec file. Or even just
+`gem install foobara-agent-backed-command` if just playing with it directly in scripts.
+
+## Usage
+
+You can make an AgentBackedCommand by subclassing Foobara::AgentBackedCommand.
+You can specify whatever inputs/result types you want or you can omit them.
+
+Here's a very short example from the loan-origination foobara demo domain:
+
+```ruby
+class FoobaraDemo::LoanOrigination::ReviewAllLoanFilesNeedingReview < Foobara::AgentBackedCommand
+end
+```
+
+A more fleshed-out version might be:
+
+```ruby
+class FoobaraDemo::LoanOrigination::ReviewAllLoanFilesNeedingReview < Foobara::AgentBackedCommand
+  description "Checks each LoanFile needing review against all requirements in its CreditPolicy. " \
+                "If any requirement is not satisfied, it will be denied. Otherwise, approved"
+  verbose
+
+  result do
+    approved [{ applicant_name: :string }]
+    denied [{ applicant_name: :string, denied_reasons: [:denied_reason] }]
+  end
+end
+```
+
+Notice how we don't need to specify an execute method. The AgentBackedCommand choose which commands from its
+domain to execute. Here's some example output of running the above command:
+
+```
+$ loan-origination ReviewAllLoanFilesNeedingReview --agent-options-verbose
+Foobara::Agent::DescribeCommand.run(command_name: "Foobara::Agent::ListCommands")
+Foobara::Agent::ListCommands.run
+Foobara::Agent::DescribeCommand.run(command_name: "FoobaraDemo::LoanOrigination::FindALoanFileThatNeedsReview")
+FoobaraDemo::LoanOrigination::FindALoanFileThatNeedsReview.run
+Foobara::Agent::DescribeCommand.run(command_name: "FoobaraDemo::LoanOrigination::FindCreditPolicy")
+FoobaraDemo::LoanOrigination::FindCreditPolicy.run(credit_policy: 64)
+Foobara::Agent::DescribeCommand.run(command_name: "FoobaraDemo::LoanOrigination::DenyLoanFile")
+FoobaraDemo::LoanOrigination::DenyLoanFile.run(loan_file: 64, credit_score_used: 650, denied_reasons: ["low_credit_score"])
+Command FoobaraDemo::LoanOrigination::DenyLoanFile failed {"data.loan_file.cannot_transition_state" => {key: "data.loan_file.cannot_transition_state", path: [:loan_file], runtime_path: [], category: :data, symbol: :cannot_transition_state, message: "Cannot perform deny transition for loan file 64 from needs_review. Expected state to be one of: [:in_review]. Did you forget to start the review?", context: {loan_file_id: 64, current_state: :needs_review, required_states: [:in_review], attempted_transition: :deny}, is_fatal: false}}
+Foobara::Agent::DescribeCommand.run(command_name: "FoobaraDemo::LoanOrigination::StartUnderwriterReview")
+FoobaraDemo::LoanOrigination::StartUnderwriterReview.run(loan_file: 64)
+FoobaraDemo::LoanOrigination::DenyLoanFile.run(loan_file: 64, credit_score_used: 650, denied_reasons: ["low_credit_score"])
+FoobaraDemo::LoanOrigination::FindALoanFileThatNeedsReview.run
+FoobaraDemo::LoanOrigination::FindCreditPolicy.run(credit_policy: 65)
+FoobaraDemo::LoanOrigination::StartUnderwriterReview.run(loan_file: 65)
+FoobaraDemo::LoanOrigination::DenyLoanFile.run(loan_file: 65, credit_score_used: 750, denied_reasons: ["insufficient_pay_stubs_provided"])
+FoobaraDemo::LoanOrigination::FindALoanFileThatNeedsReview.run
+FoobaraDemo::LoanOrigination::FindCreditPolicy.run(credit_policy: 66)
+FoobaraDemo::LoanOrigination::StartUnderwriterReview.run(loan_file: 66)
+Foobara::Agent::DescribeCommand.run(command_name: "FoobaraDemo::LoanOrigination::ApproveLoanFile")
+FoobaraDemo::LoanOrigination::ApproveLoanFile.run(loan_file: 66, credit_score_used: 750)
+FoobaraDemo::LoanOrigination::FindALoanFileThatNeedsReview.run
+Foobara::Agent::DescribeCommand.run(command_name: "Foobara::Agent::ReviewAllLoanFilesNeedingReviewAgent::NotifyUserThatCurrentGoalHasBeenAccomplished")
+Foobara::Agent::ReviewAllLoanFilesNeedingReviewAgent::NotifyUserThatCurrentGoalHasBeenAccomplished.run(approved: [{"applicant_name" => "Fumiko"}], denied: [{"applicant_name" => "Barbara", "denied_reasons" => ["low_credit_score"]}, {"applicant_name" => "Basil", "denied_reasons" => ["insufficient_pay_stubs_provided"]}])
+approved: [
+  {
+    applicant_name: "Fumiko"
+  }
+],
+denied: [
+  {
+    applicant_name: "Barbara",
+    denied_reasons: [
+      "low_credit_score"
+    ]
+  },
+  {
+    applicant_name: "Basil",
+    denied_reasons: [
+      "insufficient_pay_stubs_provided"
+    ]
+  }
+]
+```
+
+Here, we used a CLI connector to let us run it from the command line. 
+We ran it with the `--agent-options-verbose` flag to get verbose output from command. We can see
+all of the commands from the domain it ran to accomplish its goal. Also, it gave us its result in the
+format we wanted. We can connect this command in any way we'd connect any other Foobara command.
+
+Here's an example with inputs:
+
+```ruby
+module FoobaraDemo
+  module LoanOrigination
+    class ReviewLoanFile < Foobara::AgentBackedCommand
+      description "Performs a review of the given LoanFile by checking it " \
+                  "against all requirements in its CreditPolicy. " \
+                  "If any requirement is not satisfied, it will be denied. Otherwise, approved"
+      verbose
+
+      add_inputs do
+        loan_file LoanFile, :required
+      end
+
+      result LoanFile::UnderwriterDecision
+    end
+  end
+end
+```
+
+running this command in a CLI connector gives the following output:
+
+```
+╚loan-origination ReviewLoanFile --agent-options-verbose --loan-file 72
+Foobara::Agent::DescribeCommand.run(command_name: "Foobara::Agent::ListCommands")
+Foobara::Agent::ListCommands.run
+Foobara::Agent::DescribeCommand.run(command_name: "FoobaraDemo::LoanOrigination::FindCreditPolicy")
+FoobaraDemo::LoanOrigination::FindCreditPolicy.run(credit_policy: 72)
+Foobara::Agent::DescribeCommand.run(command_name: "FoobaraDemo::LoanOrigination::ApproveLoanFile")
+FoobaraDemo::LoanOrigination::ApproveLoanFile.run(loan_file: 72, credit_score_used: 750)
+Command FoobaraDemo::LoanOrigination::ApproveLoanFile failed {"data.loan_file.cannot_transition_state" => {key: "data.loan_file.cannot_transition_state", path: [:loan_file], runtime_path: [], category: :data, symbol: :cannot_transition_state, message: "Cannot perform approve transition for loan file 72 from needs_review. Expected state to be one of: [:in_review]. Did you forget to start the review?", context: {loan_file_id: 72, current_state: :needs_review, required_states: [:in_review], attempted_transition: :approve}, is_fatal: false}}
+FoobaraDemo::LoanOrigination::StartUnderwriterReview.run(loan_file: 72)
+FoobaraDemo::LoanOrigination::ApproveLoanFile.run(loan_file: 72, credit_score_used: 750)
+Foobara::Agent::DescribeCommand.run(command_name: "Foobara::Agent::ReviewLoanFileAgent::NotifyUserThatCurrentGoalHasBeenAccomplished")
+Foobara::Agent::ReviewLoanFileAgent::NotifyUserThatCurrentGoalHasBeenAccomplished.run(result: {"decision" => "approved", "credit_score_used" => 750})
+decision: "approved",
+credit_score_used: 750
+```
+
+And we can also just run this command directly and use its result programmatically if we want:
+
+```
+irb(main):001> outcome = FoobaraDemo::LoanOrigination::ReviewLoanFile.run(loan_file: 71, agent_options: {verbose: true})
+Foobara::Agent::DescribeCommand.run(command_name: "Foobara::Agent::ListCommands")
+Foobara::Agent::ListCommands.run
+Foobara::Agent::DescribeCommand.run(command_name: "FoobaraDemo::LoanOrigination::FindCreditPolicy")
+FoobaraDemo::LoanOrigination::FindCreditPolicy.run(credit_policy: 71)
+Foobara::Agent::DescribeCommand.run(command_name: "FoobaraDemo::LoanOrigination::StartUnderwriterReview")
+FoobaraDemo::LoanOrigination::StartUnderwriterReview.run(loan_file: 71)
+Foobara::Agent::DescribeCommand.run(command_name: "FoobaraDemo::LoanOrigination::DenyLoanFile")
+FoobaraDemo::LoanOrigination::DenyLoanFile.run(loan_file: 71, credit_score_used: 750, denied_reasons: ["insufficient_pay_stubs_provided"])
+Foobara::Agent::DescribeCommand.run(command_name: "Foobara::Agent::ReviewLoanFileAgent::NotifyUserThatCurrentGoalHasBeenAccomplished")
+Foobara::Agent::ReviewLoanFileAgent::NotifyUserThatCurrentGoalHasBeenAccomplished.run(result: {"decision" => "denied", "credit_score_used" => 750, "denied_reasons" => ["insufficient_pay_stubs_provided"]})
+=> 
+#<Foobara::Outcome:0x00007f9a989fe8b0
+...
+irb(main):002> outcome.success?
+=> true
+irb(main):003> outcome.result
+=> 
+#<FoobaraDemo::LoanOrigination::LoanFile::UnderwriterDecision:0x00007f9a981f24a0
+ @attributes={decision: "denied", credit_score_used: 750, denied_reasons: ["insufficient_pay_stubs_provided"]},
+ @mutable=true,
+ @skip_validations=nil>
+irb(main):004> underwriter_decision = outcome.result
+=> 
+#<FoobaraDemo::LoanOrigination::LoanFile::UnderwriterDecision:0x00007f9a981f24a0
+...
+irb(main):005> underwriter_decision.denied_reasons.first
+=> "insufficient_pay_stubs_provided"
+```
+
+We could now let our original AgentBackedCommand call this new one we wrote just like any other command. 
+This means we'd have one agent orchestrating another without even knowing that that's what its doing:
+
+```ruby
+module FoobaraDemo
+  module LoanOrigination
+    class ReviewLoanFile < Foobara::AgentBackedCommand
+      add_inputs do
+        loan_file LoanFile, :required
+      end
+
+      result LoanFile::UnderwriterDecision
+
+      depends_on StartUnderwriterReview,
+                 FindCreditPolicy,
+                 DenyLoanFile,
+                 ApproveLoanFile
+
+      verbose
+    end
+
+    class ReviewAllLoanFilesNeedingReview < Foobara::AgentBackedCommand
+      result do
+        approved_count :integer, :required
+        denied_count :integer, :required
+      end
+      depends_on FindALoanFileThatNeedsReview, ReviewLoanFile
+      verbose
+    end
+  end
+end
+
+outcome = FoobaraDemo::LoanOrigination::ReviewAllLoanFilesNeedingReview.run
+
+if outcome.success?
+  result = outcome.result
+
+  puts "Great success!!"
+  puts "Approved: #{result[:approved_count]}"
+  puts "Denied: #{result[:denied_count]}"
+else
+  warn "Error: #{outcome.errors_hash}"
+end
+```
+
+Which gives the following output:
+
+```
+Foobara::Agent::DescribeCommand.run(command_name: "Foobara::Agent::ListCommands")
+Foobara::Agent::ListCommands.run
+Foobara::Agent::DescribeCommand.run(command_name: "FoobaraDemo::LoanOrigination::FindALoanFileThatNeedsReview")
+FoobaraDemo::LoanOrigination::FindALoanFileThatNeedsReview.run
+Foobara::Agent::DescribeCommand.run(command_name: "FoobaraDemo::LoanOrigination::ReviewLoanFile")
+FoobaraDemo::LoanOrigination::ReviewLoanFile.run(loan_file: 79)
+Foobara::Agent::DescribeCommand.run(command_name: "Foobara::Agent::ListCommands")
+Foobara::Agent::ListCommands.run
+Foobara::Agent::DescribeCommand.run(command_name: "FoobaraDemo::LoanOrigination::StartUnderwriterReview")
+FoobaraDemo::LoanOrigination::StartUnderwriterReview.run(loan_file: 79)
+Foobara::Agent::DescribeCommand.run(command_name: "FoobaraDemo::LoanOrigination::FindCreditPolicy")
+FoobaraDemo::LoanOrigination::FindCreditPolicy.run(credit_policy: 79)
+Foobara::Agent::DescribeCommand.run(command_name: "FoobaraDemo::LoanOrigination::DenyLoanFile")
+FoobaraDemo::LoanOrigination::DenyLoanFile.run(loan_file: 79, credit_score_used: 650, denied_reasons: ["low_credit_score"])
+Foobara::Agent::DescribeCommand.run(command_name: "Foobara::Agent::ReviewLoanFileAgent::NotifyUserThatCurrentGoalHasBeenAccomplished")
+Foobara::Agent::ReviewLoanFileAgent::NotifyUserThatCurrentGoalHasBeenAccomplished.run(result: {"decision" => "denied", "credit_score_used" => 650, "denied_reasons" => ["low_credit_score"]})
+FoobaraDemo::LoanOrigination::FindALoanFileThatNeedsReview.run
+FoobaraDemo::LoanOrigination::ReviewLoanFile.run(loan_file: 80)
+Foobara::Agent::DescribeCommand.run(command_name: "Foobara::Agent::ListCommands")
+Foobara::Agent::ListCommands.run
+Foobara::Agent::DescribeCommand.run(command_name: "FoobaraDemo::LoanOrigination::StartUnderwriterReview")
+FoobaraDemo::LoanOrigination::StartUnderwriterReview.run(loan_file: 80)
+Foobara::Agent::DescribeCommand.run(command_name: "FoobaraDemo::LoanOrigination::FindCreditPolicy")
+FoobaraDemo::LoanOrigination::FindCreditPolicy.run(credit_policy: 80)
+Foobara::Agent::DescribeCommand.run(command_name: "FoobaraDemo::LoanOrigination::ApproveLoanFile")
+FoobaraDemo::LoanOrigination::ApproveLoanFile.run(loan_file: 80, credit_score_used: 750)
+Foobara::Agent::DescribeCommand.run(command_name: "Foobara::Agent::ReviewLoanFileAgent::NotifyUserThatCurrentGoalHasBeenAccomplished")
+Foobara::Agent::ReviewLoanFileAgent::NotifyUserThatCurrentGoalHasBeenAccomplished.run(result: {"decision" => "approved", "credit_score_used" => 750})
+FoobaraDemo::LoanOrigination::FindALoanFileThatNeedsReview.run
+FoobaraDemo::LoanOrigination::ReviewLoanFile.run(loan_file: 81)
+Foobara::Agent::DescribeCommand.run(command_name: "Foobara::Agent::ListCommands")
+Foobara::Agent::ListCommands.run
+Foobara::Agent::DescribeCommand.run(command_name: "FoobaraDemo::LoanOrigination::StartUnderwriterReview")
+FoobaraDemo::LoanOrigination::StartUnderwriterReview.run(loan_file: 81)
+Foobara::Agent::DescribeCommand.run(command_name: "FoobaraDemo::LoanOrigination::FindCreditPolicy")
+FoobaraDemo::LoanOrigination::FindCreditPolicy.run(credit_policy: 81)
+Foobara::Agent::DescribeCommand.run(command_name: "FoobaraDemo::LoanOrigination::ApproveLoanFile")
+FoobaraDemo::LoanOrigination::ApproveLoanFile.run(loan_file: 81, credit_score_used: 750)
+Foobara::Agent::DescribeCommand.run(command_name: "Foobara::Agent::ReviewLoanFileAgent::NotifyUserThatCurrentGoalHasBeenAccomplished")
+Foobara::Agent::ReviewLoanFileAgent::NotifyUserThatCurrentGoalHasBeenAccomplished.run(result: {"decision" => "approved", "credit_score_used" => 750})
+FoobaraDemo::LoanOrigination::FindALoanFileThatNeedsReview.run
+Foobara::Agent::DescribeCommand.run(command_name: "Foobara::Agent::ReviewAllLoanFilesNeedingReviewAgent::NotifyUserThatCurrentGoalHasBeenAccomplished")
+Foobara::Agent::ReviewAllLoanFilesNeedingReviewAgent::NotifyUserThatCurrentGoalHasBeenAccomplished.run(approved_count: 2, denied_count: 1)
+Great success!!
+Approved: 2
+Denied: 1
+```
+
+Here you can see two agents working together to solve the problem without either knowing it.
+
+## Contributing
+
+Helllllp! If this project seems interesting and you want to try using it or you want to help, please get in touch!
+There's no shortage of work to do of any experience level.
+
+Bug reports and pull requests are welcome on GitHub
+at https://github.com/foobara/agent-backed-command
+
+## License
+
+This project is licensed under the MPL-2.0 license. Please see LICENSE.txt for more info.

data/lib/foobara/agent_backed_command.rb

@@ -0,0 +1,3 @@
+require "foobara/all"
+
+Foobara::Util.require_directory "#{__dir__}/../../src"

data/src/agent_backed_command.rb

@@ -0,0 +1,201 @@
+require "foobara/agent"
+
+module Foobara
+  class AgentBackedCommand < Foobara::Command
+    # TODO: grab these right off Foobara::AccomplishGoal somehow?
+    possible_error :gave_up, context: { reason: :string }, message: "Gave up."
+    possible_error :too_many_command_calls,
+                   context: { maximum_command_calls: :integer }
+
+    class << self
+      # TODO: does this need to be a Concern for proper inheritance?
+      attr_accessor :is_verbose, :io_out, :io_err, :context, :agent_name, :llm_model, :max_llm_calls_per_minute
+
+      def verbose(value = true)
+        self.is_verbose = value
+      end
+
+      def verbose?
+        is_verbose
+      end
+    end
+
+    inputs do
+      agent_options do
+        verbose :boolean
+        io_out :duck
+        io_err :duck
+        context Foobara::Agent::Context, :allow_nil, "The current context of the agent"
+        agent_name :string, :allow_nil
+        llm_model :string,
+                  :allow_nil,
+                  one_of: Foobara::Ai::AnswerBot::Types::ModelEnum,
+                  description: "The model to use for the LLM"
+        max_llm_calls_per_minute :integer, :allow_nil
+      end
+    end
+
+    def execute
+      build_agent_if_needed
+      construct_goal_if_needed
+
+      run_agent
+      handle_agent_outcome
+
+      agent_result
+    end
+
+    attr_writer :goal, :agent
+    attr_accessor :agent_outcome, :returns_message_to_user, :returns_result_data, :result_data_is_merged
+
+    def build_agent_if_needed
+      return if agent
+
+      command_classes = self.class.depends_on
+
+      if command_classes.empty?
+        # TODO: push this up into a helper in foobara/foobara
+        is_global_domain = self.class.foobara_domain.scoped_path.empty?
+        unless is_global_domain
+          command_classes = self.class.foobara_domain.foobara_all_command(mode: Namespace::LookupMode::DIRECT)
+          command_classes -= [self.class]
+        end
+      end
+
+      result_type = self.class.result_type
+
+      agent_result_type = if result_type&.extends?(BuiltinTypes[:attributes]) &&
+                             result_type.element_types.key?(:message_to_user)
+                            self.returns_message_to_user = true
+                            include_message_to_user_in_result = true
+
+                            if result_type.element_types.size == 1
+                              nil
+                            else
+                              self.returns_result_data = true
+
+                              if result_type.element_types.keys.sort == [:message_to_user, :result_data]
+                                result_type.element_types[:result_data]
+                              else
+                                self.result_data_is_merged = true
+
+                                declaration = result_type.declaration_data
+                                declaration = TypeDeclarations::Attributes.reject(declaration, :message_to_user)
+                                result_type.created_in_namespace.foobara_type_from_declaration(declaration)
+                              end
+                            end
+                          else
+                            include_message_to_user_in_result = false
+                            if result_type
+                              self.returns_result_data = true
+                              result_type
+                            end
+                          end
+
+      agent_name = agent_options&.[](:agent_name) || self.class.agent_name || "#{self.class.scoped_short_name}Agent"
+
+      verbose = agent_options&.[](:verbose)
+      verbose = self.class.verbose? if verbose.nil?
+
+      self.agent = Foobara::Agent.new(
+        command_classes:,
+        include_message_to_user_in_result:,
+        result_type: agent_result_type,
+        verbose:,
+        io_out: agent_options&.[](:io_out) || self.class.io_out,
+        io_err: agent_options&.[](:io_err) || self.class.io_err,
+        agent_name:,
+        context: agent_options&.[](:context) || self.class.context,
+        llm_model: agent_options&.[](:llm_model) || self.class.llm_model,
+        max_llm_calls_per_minute: agent_options&.[](:max_llm_calls_per_minute) || self.class.max_llm_calls_per_minute
+      )
+    end
+
+    def construct_goal_if_needed
+      unless self.goal
+        goal = self.class.scoped_short_name
+        goal = Util.underscore(goal)
+        goal = Util.humanize(goal)
+
+        goal = "You are an agent backed command named #{self.class.scoped_short_name}. Your goal is: #{goal}."
+
+        if self.class.description
+          goal += " The command description is: #{self.class.description}."
+        end
+
+        inputs_type = self.class.inputs_type
+        if inputs_type
+          input_keys = inputs_type.element_types.keys - [:agent_options]
+
+          unless input_keys.empty?
+            domain = inputs_type.created_in_namespace.foobara_domain
+            inputs_type = TypeDeclarations::Attributes.reject(inputs_type.declaration_data, :agent_options)
+            inputs_type = domain.foobara_type_from_declaration(inputs_type)
+
+            json_inputs_type = JsonSchemaGenerator.to_json_schema(
+              inputs_type,
+              association_depth: JsonSchemaGenerator::AssociationDepth::ATOM
+            )
+            goal += " The inputs to this command have the following type:\n\n#{json_inputs_type}\n\n"
+
+            serializer = Foobara::CommandConnectors::Serializers::AtomicSerializer.new
+            inputs_json = serializer.serialize(inputs.except(:agent_options))
+            inputs_json = JSON.fast_generate(inputs_json)
+            goal += "You have been ran with the following inputs:\n\n#{inputs_json}"
+          end
+        end
+
+        @goal = goal
+      end
+    end
+
+    def run_agent
+      self.agent_outcome = agent.run(goal)
+    end
+
+    def handle_agent_outcome
+      unless agent_outcome.success?
+        # TODO: test this code path maybe with a stub that forces failure
+        # :nocov:
+        agent_outcome.each_error do |error|
+          add_error(error)
+        rescue Halt
+          nil
+        end
+
+        halt!
+        # :nocov:
+      end
+    end
+
+    def agent_result
+      result = agent_outcome.result
+
+      if returns_message_to_user
+        message_to_user = result[:message_to_user]
+
+        if returns_result_data
+          result_data = result[:result_data]
+
+          if result_data_is_merged
+            result_data.merge(message_to_user:)
+          else
+            { message_to_user:, result_data: }
+          end
+        else
+          { message_to_user: }
+        end
+      elsif returns_result_data
+        result[:result_data]
+      end
+    end
+
+    def agent
+      @agent || inputs[:agent]
+    end
+
+    def goal
+      @goal || inputs[:goal]
+    end
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: foobara-agent-backed-command
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Miles Georgi
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: foobara-agent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+email:
+- azimux@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE-MPL-2.0.txt
+- LICENSE.txt
+- README.md
+- lib/foobara/agent_backed_command.rb
+- src/agent_backed_command.rb
+homepage: https://github.com/foobara/agent-backed-command
+licenses:
+- MPL-2.0
+metadata:
+  homepage_uri: https://github.com/foobara/agent-backed-command
+  source_code_uri: https://github.com/foobara/agent-backed-command
+  changelog_uri: https://github.com/foobara/agent-backed-command/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Provides a way to create a command without an execute method that is instead
+  executed by a Foobara::Agent
+test_files: []