brown-octopus 0.4.4__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (30) hide show
  1. brown_octopus-0.4.4/LICENSE +201 -0
  2. brown_octopus-0.4.4/PKG-INFO +404 -0
  3. brown_octopus-0.4.4/README.md +174 -0
  4. brown_octopus-0.4.4/pyproject.toml +59 -0
  5. brown_octopus-0.4.4/pyproject.toml.orig +46 -0
  6. brown_octopus-0.4.4/src/brown_octopus/__init__.py +24 -0
  7. brown_octopus-0.4.4/src/brown_octopus/active_tools.py +39 -0
  8. brown_octopus-0.4.4/src/brown_octopus/analyzer.py +296 -0
  9. brown_octopus-0.4.4/src/brown_octopus/bootstrap.py +35 -0
  10. brown_octopus-0.4.4/src/brown_octopus/cli.py +220 -0
  11. brown_octopus-0.4.4/src/brown_octopus/config.py +44 -0
  12. brown_octopus-0.4.4/src/brown_octopus/context_manager.py +62 -0
  13. brown_octopus-0.4.4/src/brown_octopus/contracts.py +100 -0
  14. brown_octopus-0.4.4/src/brown_octopus/errors.py +38 -0
  15. brown_octopus-0.4.4/src/brown_octopus/index_store.py +146 -0
  16. brown_octopus-0.4.4/src/brown_octopus/mcp_discovery.py +123 -0
  17. brown_octopus-0.4.4/src/brown_octopus/model_store.py +90 -0
  18. brown_octopus-0.4.4/src/brown_octopus/observability.py +24 -0
  19. brown_octopus-0.4.4/src/brown_octopus/octopus.py +441 -0
  20. brown_octopus-0.4.4/src/brown_octopus/pipeline.py +159 -0
  21. brown_octopus-0.4.4/src/brown_octopus/py.typed +0 -0
  22. brown_octopus-0.4.4/src/brown_octopus/retriever.py +192 -0
  23. brown_octopus-0.4.4/src/brown_octopus/selection.py +74 -0
  24. brown_octopus-0.4.4/src/brown_octopus/server.py +13 -0
  25. brown_octopus-0.4.4/src/brown_octopus/service.py +54 -0
  26. brown_octopus-0.4.4/src/brown_octopus/session_store.py +76 -0
  27. brown_octopus-0.4.4/src/brown_octopus/setup_models.py +220 -0
  28. brown_octopus-0.4.4/src/brown_octopus/sources.py +64 -0
  29. brown_octopus-0.4.4/src/brown_octopus/strategies.py +91 -0
  30. brown_octopus-0.4.4/src/brown_octopus/tool_registry.py +33 -0
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,404 @@
1
+ Metadata-Version: 2.3
2
+ Name: brown-octopus
3
+ Version: 0.4.4
4
+ Summary: Capability-context management for tool-using AI agents
5
+ Keywords: AI agents,MCP,tool retrieval,capability context
6
+ Author: nana brown
7
+ Author-email: nana brown <nanabrownsnr@gmail.com>
8
+ License: Apache License
9
+ Version 2.0, January 2004
10
+ http://www.apache.org/licenses/
11
+
12
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
13
+
14
+ 1. Definitions.
15
+
16
+ "License" shall mean the terms and conditions for use, reproduction,
17
+ and distribution as defined by Sections 1 through 9 of this document.
18
+
19
+ "Licensor" shall mean the copyright owner or entity authorized by
20
+ the copyright owner that is granting the License.
21
+
22
+ "Legal Entity" shall mean the union of the acting entity and all
23
+ other entities that control, are controlled by, or are under common
24
+ control with that entity. For the purposes of this definition,
25
+ "control" means (i) the power, direct or indirect, to cause the
26
+ direction or management of such entity, whether by contract or
27
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
28
+ outstanding shares, or (iii) beneficial ownership of such entity.
29
+
30
+ "You" (or "Your") shall mean an individual or Legal Entity
31
+ exercising permissions granted by this License.
32
+
33
+ "Source" form shall mean the preferred form for making modifications,
34
+ including but not limited to software source code, documentation
35
+ source, and configuration files.
36
+
37
+ "Object" form shall mean any form resulting from mechanical
38
+ transformation or translation of a Source form, including but
39
+ not limited to compiled object code, generated documentation,
40
+ and conversions to other media types.
41
+
42
+ "Work" shall mean the work of authorship, whether in Source or
43
+ Object form, made available under the License, as indicated by a
44
+ copyright notice that is included in or attached to the work
45
+ (an example is provided in the Appendix below).
46
+
47
+ "Derivative Works" shall mean any work, whether in Source or Object
48
+ form, that is based on (or derived from) the Work and for which the
49
+ editorial revisions, annotations, elaborations, or other modifications
50
+ represent, as a whole, an original work of authorship. For the purposes
51
+ of this License, Derivative Works shall not include works that remain
52
+ separable from, or merely link (or bind by name) to the interfaces of,
53
+ the Work and Derivative Works thereof.
54
+
55
+ "Contribution" shall mean any work of authorship, including
56
+ the original version of the Work and any modifications or additions
57
+ to that Work or Derivative Works thereof, that is intentionally
58
+ submitted to Licensor for inclusion in the Work by the copyright owner
59
+ or by an individual or Legal Entity authorized to submit on behalf of
60
+ the copyright owner. For the purposes of this definition, "submitted"
61
+ means any form of electronic, verbal, or written communication sent
62
+ to the Licensor or its representatives, including but not limited to
63
+ communication on electronic mailing lists, source code control systems,
64
+ and issue tracking systems that are managed by, or on behalf of, the
65
+ Licensor for the purpose of discussing and improving the Work, but
66
+ excluding communication that is conspicuously marked or otherwise
67
+ designated in writing by the copyright owner as "Not a Contribution."
68
+
69
+ "Contributor" shall mean Licensor and any individual or Legal Entity
70
+ on behalf of whom a Contribution has been received by Licensor and
71
+ subsequently incorporated within the Work.
72
+
73
+ 2. Grant of Copyright License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ copyright license to reproduce, prepare Derivative Works of,
77
+ publicly display, publicly perform, sublicense, and distribute the
78
+ Work and such Derivative Works in Source or Object form.
79
+
80
+ 3. Grant of Patent License. Subject to the terms and conditions of
81
+ this License, each Contributor hereby grants to You a perpetual,
82
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
83
+ (except as stated in this section) patent license to make, have made,
84
+ use, offer to sell, sell, import, and otherwise transfer the Work,
85
+ where such license applies only to those patent claims licensable
86
+ by such Contributor that are necessarily infringed by their
87
+ Contribution(s) alone or by combination of their Contribution(s)
88
+ with the Work to which such Contribution(s) was submitted. If You
89
+ institute patent litigation against any entity (including a
90
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
91
+ or a Contribution incorporated within the Work constitutes direct
92
+ or contributory patent infringement, then any patent licenses
93
+ granted to You under this License for that Work shall terminate
94
+ as of the date such litigation is filed.
95
+
96
+ 4. Redistribution. You may reproduce and distribute copies of the
97
+ Work or Derivative Works thereof in any medium, with or without
98
+ modifications, and in Source or Object form, provided that You
99
+ meet the following conditions:
100
+
101
+ (a) You must give any other recipients of the Work or
102
+ Derivative Works a copy of this License; and
103
+
104
+ (b) You must cause any modified files to carry prominent notices
105
+ stating that You changed the files; and
106
+
107
+ (c) You must retain, in the Source form of any Derivative Works
108
+ that You distribute, all copyright, patent, trademark, and
109
+ attribution notices from the Source form of the Work,
110
+ excluding those notices that do not pertain to any part of
111
+ the Derivative Works; and
112
+
113
+ (d) If the Work includes a "NOTICE" text file as part of its
114
+ distribution, then any Derivative Works that You distribute must
115
+ include a readable copy of the attribution notices contained
116
+ within such NOTICE file, excluding those notices that do not
117
+ pertain to any part of the Derivative Works, in at least one
118
+ of the following places: within a NOTICE text file distributed
119
+ as part of the Derivative Works; within the Source form or
120
+ documentation, if provided along with the Derivative Works; or,
121
+ within a display generated by the Derivative Works, if and
122
+ wherever such third-party notices normally appear. The contents
123
+ of the NOTICE file are for informational purposes only and
124
+ do not modify the License. You may add Your own attribution
125
+ notices within Derivative Works that You distribute, alongside
126
+ or as an addendum to the NOTICE text from the Work, provided
127
+ that such additional attribution notices cannot be construed
128
+ as modifying the License.
129
+
130
+ You may add Your own copyright statement to Your modifications and
131
+ may provide additional or different license terms and conditions
132
+ for use, reproduction, or distribution of Your modifications, or
133
+ for any such Derivative Works as a whole, provided Your use,
134
+ reproduction, and distribution of the Work otherwise complies with
135
+ the conditions stated in this License.
136
+
137
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
138
+ any Contribution intentionally submitted for inclusion in the Work
139
+ by You to the Licensor shall be under the terms and conditions of
140
+ this License, without any additional terms or conditions.
141
+ Notwithstanding the above, nothing herein shall supersede or modify
142
+ the terms of any separate license agreement you may have executed
143
+ with Licensor regarding such Contributions.
144
+
145
+ 6. Trademarks. This License does not grant permission to use the trade
146
+ names, trademarks, service marks, or product names of the Licensor,
147
+ except as required for reasonable and customary use in describing the
148
+ origin of the Work and reproducing the content of the NOTICE file.
149
+
150
+ 7. Disclaimer of Warranty. Unless required by applicable law or
151
+ agreed to in writing, Licensor provides the Work (and each
152
+ Contributor provides its Contributions) on an "AS IS" BASIS,
153
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
154
+ implied, including, without limitation, any warranties or conditions
155
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
156
+ PARTICULAR PURPOSE. You are solely responsible for determining the
157
+ appropriateness of using or redistributing the Work and assume any
158
+ risks associated with Your exercise of permissions under this License.
159
+
160
+ 8. Limitation of Liability. In no event and under no legal theory,
161
+ whether in tort (including negligence), contract, or otherwise,
162
+ unless required by applicable law (such as deliberate and grossly
163
+ negligent acts) or agreed to in writing, shall any Contributor be
164
+ liable to You for damages, including any direct, indirect, special,
165
+ incidental, or consequential damages of any character arising as a
166
+ result of this License or out of the use or inability to use the
167
+ Work (including but not limited to damages for loss of goodwill,
168
+ work stoppage, computer failure or malfunction, or any and all
169
+ other commercial damages or losses), even if such Contributor
170
+ has been advised of the possibility of such damages.
171
+
172
+ 9. Accepting Warranty or Additional Liability. While redistributing
173
+ the Work or Derivative Works thereof, You may choose to offer,
174
+ and charge a fee for, acceptance of support, warranty, indemnity,
175
+ or other liability obligations and/or rights consistent with this
176
+ License. However, in accepting such obligations, You may act only
177
+ on Your own behalf and on Your sole responsibility, not on behalf
178
+ of any other Contributor, and only if You agree to indemnify,
179
+ defend, and hold each Contributor harmless for any liability
180
+ incurred by, or claims asserted against, such Contributor by reason
181
+ of your accepting any such warranty or additional liability.
182
+
183
+ END OF TERMS AND CONDITIONS
184
+
185
+ APPENDIX: How to apply the Apache License to your work.
186
+
187
+ To apply the Apache License to your work, attach the following
188
+ boilerplate notice, with the fields enclosed by brackets "[]"
189
+ replaced with your own identifying information. (Don't include
190
+ the brackets!) The text should be enclosed in the appropriate
191
+ comment syntax for the file format. We also recommend that a
192
+ file or class name and description of purpose be included on the
193
+ same "printed page" as the copyright notice for easier
194
+ identification within third-party archives.
195
+
196
+ Copyright [yyyy] [name of copyright owner]
197
+
198
+ Licensed under the Apache License, Version 2.0 (the "License");
199
+ you may not use this file except in compliance with the License.
200
+ You may obtain a copy of the License at
201
+
202
+ http://www.apache.org/licenses/LICENSE-2.0
203
+
204
+ Unless required by applicable law or agreed to in writing, software
205
+ distributed under the License is distributed on an "AS IS" BASIS,
206
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
207
+ See the License for the specific language governing permissions and
208
+ limitations under the License.
209
+ Classifier: Development Status :: 4 - Beta
210
+ Classifier: Intended Audience :: Developers
211
+ Classifier: Programming Language :: Python :: 3
212
+ Classifier: Programming Language :: Python :: 3.13
213
+ Requires-Dist: fastmcp>=4.0.3
214
+ Requires-Dist: numpy>=2.5.3
215
+ Requires-Dist: packaging>=24.0
216
+ Requires-Dist: sentence-transformers>=6.0.1
217
+ Requires-Dist: spacy>=3.8.16
218
+ Requires-Dist: jev-reranker>=0.1.0 ; extra == 'jev'
219
+ Requires-Dist: fastapi>=0.115.0 ; extra == 'service'
220
+ Requires-Dist: uvicorn[standard]>=0.34.0 ; extra == 'service'
221
+ Requires-Dist: pyarrow>=18.0.0 ; extra == 'toolret'
222
+ Requires-Python: >=3.13
223
+ Project-URL: Repository, https://github.com/nanabrownsnr/brownoctopus
224
+ Project-URL: Documentation, https://github.com/nanabrownsnr/brownoctopus/blob/main/docs/production.md
225
+ Project-URL: Issues, https://github.com/nanabrownsnr/brownoctopus/issues
226
+ Provides-Extra: jev
227
+ Provides-Extra: service
228
+ Provides-Extra: toolret
229
+ Description-Content-Type: text/markdown
230
+
231
+ # Brown Octopus
232
+
233
+ Brown Octopus is a Python library for dynamic capability-context management
234
+ for tool-using AI agents. It determines which capability definitions should be
235
+ available to an agent on each interaction. It does not execute tools, manage
236
+ credentials, or replace the host agent framework.
237
+
238
+ ## Install
239
+
240
+ ```bash
241
+ pip install brown-octopus
242
+ brown-octopus setup-models
243
+ ```
244
+
245
+ `setup-models` explicitly prepares `en_core_web_trf` and
246
+ `Qwen/Qwen3-Embedding-0.6B` in Brown Octopus-managed persistent storage.
247
+ Normal initialization does not download models.
248
+
249
+ ## Quick start
250
+
251
+ ```python
252
+ from brown_octopus import Octopus
253
+
254
+
255
+ async def main():
256
+ octopus = Octopus()
257
+ await octopus.initialize()
258
+
259
+ result = octopus.retrieve_result(
260
+ "Reply to Tom's email",
261
+ session_id="conversation-123",
262
+ )
263
+
264
+ # Final active capability context for the host agent.
265
+ for capability in result.tools:
266
+ print(capability["name"])
267
+ ```
268
+
269
+ Use `await octopus.update()` when the host deliberately wants to discover
270
+ capabilities and build an updated index. `initialize()` loads existing local
271
+ models and index state; it does not discover or download implicitly.
272
+
273
+ ## Frozen V3 pipeline
274
+
275
+ ```text
276
+ user request
277
+ -> deterministic spaCy operational-intent analysis
278
+ -> capability-oriented retrieval text
279
+ -> Qwen dense retrieval
280
+ -> Min-4 + Bounded Max Gap selection
281
+ -> merge and deduplicate
282
+ -> session capability state
283
+ -> final active capability context
284
+ -> host agent
285
+ ```
286
+
287
+ ```text
288
+ Embedding: Qwen/Qwen3-Embedding-0.6B
289
+ Analyzer: en_core_web_trf
290
+ Representation: capability name + description
291
+ MIN_TOOLS: 4 per intent
292
+ MAX_TOOLS: 16 per intent
293
+ MIN_GAP_PERCENT: 2.0
294
+ TTL: 8 turns
295
+ Active cap: 30 capabilities
296
+ ```
297
+
298
+ Brown Octopus is intentionally recall-oriented for its first production
299
+ version. It prefers a bounded set of plausible capabilities over aggressively
300
+ pruning and risking a missing required capability. It does not guarantee
301
+ perfect recall.
302
+
303
+ ## Results and sessions
304
+
305
+ ```python
306
+ result = octopus.retrieve_result(query, session_id="conversation-123")
307
+ ```
308
+
309
+ ```text
310
+ result.retrieved_tools capabilities selected on this turn
311
+ result.tools final active context after TTL/session management
312
+ result.tool_ids IDs in result.tools
313
+ result.session_id session identifier
314
+ result.turn session turn number
315
+ ```
316
+
317
+ Expose `result.tools` to the agent. Brown Octopus returns definitions and
318
+ metadata only; the host binds and executes tools.
319
+
320
+ One engine can serve many isolated conversations. Models, indexes, and
321
+ retrievers are shared; turn counters, TTL state, and active capabilities are
322
+ session-specific.
323
+
324
+ ```python
325
+ octopus.reset_session("conversation-123")
326
+ octopus.delete_session("conversation-123")
327
+ snapshot = octopus.get_session("conversation-123")
328
+ ```
329
+
330
+ The default `InMemorySessionStore` keeps serializable capability state in
331
+ process. Applications needing persistence can inject a custom store:
332
+
333
+ ```python
334
+ octopus = Octopus(session_store=my_store)
335
+ ```
336
+
337
+ Custom stores must make session mutation atomic across workers/processes.
338
+ Brown Octopus stores capability state, not conversation history.
339
+
340
+ ## Capability sources and updates
341
+
342
+ The default source reads the local MCP catalog, but the source abstraction is
343
+ provider-neutral. Use a custom source without changing the retrieval engine:
344
+
345
+ ```python
346
+ octopus = Octopus(capability_source=my_source)
347
+ report = await octopus.update()
348
+ ```
349
+
350
+ Capability identity fields are:
351
+
352
+ ```text
353
+ capability_id stable globally unique capability identity
354
+ source_id discovery provenance
355
+ mcp_url execution endpoint when applicable
356
+ ```
357
+
358
+ Failed or non-authoritative discovery does not silently delete capabilities
359
+ from unavailable sources. New index snapshots are validated and published
360
+ atomically.
361
+
362
+ ## Model storage and diagnostics
363
+
364
+ Override the managed model directory for containers or shared volumes with
365
+ `BROWN_OCTOPUS_MODEL_DIR`. Model setup remains explicit:
366
+
367
+ ```bash
368
+ brown-octopus setup-models
369
+ brown-octopus doctor
370
+ brown-octopus inspect
371
+ brown-octopus inspect --json
372
+ ```
373
+
374
+ `doctor` checks package, model, and index readiness. `inspect` reports the
375
+ active index and frozen configuration without exposing credentials.
376
+
377
+ ## Architecture boundary
378
+
379
+ Brown Octopus owns intent analysis, capability retrieval/selection, index
380
+ construction, active capability context, session capability state, and
381
+ explicit capability updates.
382
+
383
+ The host owns the LLM, conversation history, tool binding/execution,
384
+ credentials, authentication, authorization, user identity, refresh timing,
385
+ and session lifecycle policy.
386
+
387
+ Brown Octopus is harness-agnostic. A LangGraph integration example is available
388
+ at [`examples/langgraph_app`](examples/langgraph_app/README.md); LangGraph is
389
+ not a runtime dependency.
390
+
391
+ ## Development
392
+
393
+ ```bash
394
+ uv sync
395
+ brown-octopus setup-models
396
+ uv run pytest -m "not external"
397
+ uv build
398
+ ```
399
+
400
+ Historical evaluation infrastructure remains under `evals/`, benchmark data
401
+ under `data/evals/`, and research outputs under `results/`. These are separate
402
+ from the installable `brown_octopus` package.
403
+
404
+ See [`LICENSE`](LICENSE) for licensing information.