@orkestrel/tool 0.0.1

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.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Orkestrel
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,50 @@
1
+ # @orkestrel/tool
2
+
3
+ Concrete, LLM-callable **tools** for the `@orkestrel` line — built over
4
+ [`@orkestrel/agent`](https://github.com/orkestrel/agent)'s `ToolInterface` /
5
+ `createTool` runtime, with pluggable stores. Part of the `@orkestrel` line.
6
+
7
+ - **`createWorkflowTool`** — authors and runs an
8
+ [`@orkestrel/workflow`](https://github.com/orkestrel/workflow) definition in
9
+ one call (flat steps / lenient draft / full definition, depth + cycle
10
+ guarded), with an optional pluggable `WorkflowStoreInterface` that persists
11
+ each executed run's snapshot on settle.
12
+ - **`createWorkspaceTool`** — a 13-operation workspace-editing tool driving
13
+ `@orkestrel/agent`'s workspace runtime, either against a caller-supplied
14
+ manager or a fresh one built over a pluggable `WorkspaceStoreInterface`.
15
+ - **`createAgentTool`** — net-new sub-agent delegation: resolves and runs one
16
+ seeded agent via an `AgentRegistryInterface`, depth + cycle guarded,
17
+ deliberately storeless (persistence, if any, rides the registry's own
18
+ configuration).
19
+ - **Adapters** — `createToolFunction` / `createAgentFunction` compose a
20
+ registered tool or a live agent into a workflow's `functions` registry, plus
21
+ the authoring umbrella (`WorkflowSteps` / `WorkflowDraft`,
22
+ `createWorkflowDraftContract`, `workflowToolSummary`, `MAX_WORKFLOW_DEPTH`).
23
+
24
+ **Status: v0.0.1 pending publish**, once the upstream `@orkestrel/workflow` /
25
+ `@orkestrel/agent` cleanups that drop their authoring surfaces (this package
26
+ becomes the defining home) land.
27
+
28
+ ## Install
29
+
30
+ ```sh
31
+ npm install @orkestrel/tool
32
+ ```
33
+
34
+ ## Requirements
35
+
36
+ - Node.js >= 24
37
+ - Dual ESM + CommonJS builds (`import` and `require` both supported)
38
+
39
+ ## Guide
40
+
41
+ See [`guides/src/tool.md`](guides/src/tool.md).
42
+
43
+ ## Package
44
+
45
+ Published as a single typed entry point per the `exports` field in
46
+ `package.json`.
47
+
48
+ ## License
49
+
50
+ MIT © [Orkestrel](https://github.com/orkestrel) — see [LICENSE](./LICENSE).