ovos-PHAL-plugin-tools 0.0.1a1__tar.gz

ovos_phal_plugin_tools-0.0.1a1/LICENSE

@@ -0,0 +1,107 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship made available under
+      the License, as indicated by a copyright notice that is included in
+      or attached to the work (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other transformations
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean, as submitted to the Licensor for inclusion
+      in the Work by the copyright owner or by an individual or Legal Entity
+      authorized to submit on behalf of the copyright owner. For the purposes
+      of this definition, "submitted" means any form of electronic, verbal,
+      or written communication sent to the Licensor or its representatives,
+      including but not limited to communication on electronic mailing lists,
+      source code control systems, and issue tracking systems that are managed
+      by, or on behalf of, the Licensor for the purpose of documenting and
+      discussing improvements to the Work, but excluding communication that is
+      conspicured and/or labeled by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and included
+      within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those Contributions necessary to
+      make, use, or sell their Contribution(s).
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in all the Source form of any Derivative
+          Works that You distribute, all copyright, patent, trademark,
+          and attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, You must include a readable copy of the
+          attribution notices contained within such NOTICE file, in
+          at least one of the following places: within a NOTICE text
+          file distributed as part of the Derivative Works; within
+          the Source form or documentation, if provided along with the
+          Derivative Works; or, within a display generated by the
+          Derivative Works, if and wherever such third-party notices
+          normally appear.
+
+   DISCLAIMER OF WARRANTIES. The Work is provided "AS IS", WITHOUT
+   WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions
+   and limitations under the License.

ovos_phal_plugin_tools-0.0.1a1/PKG-INFO

@@ -0,0 +1,314 @@
+Metadata-Version: 2.4
+Name: ovos-PHAL-plugin-tools
+Version: 0.0.1a1
+Summary: PHAL service provider exposing OVOS tool plugins over the messagebus
+Author-email: JarbasAi <jarbasai@mailfence.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/TigreGotico/ovos-PHAL-plugin-tools
+Project-URL: Repository, https://github.com/TigreGotico/ovos-PHAL-plugin-tools
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: ovos-plugin-manager<3.0.0,>=2.3.0a1
+Requires-Dist: ovos-utils<1.0.0,>=0.1.0
+Requires-Dist: ovos-bus-client<2.0.0,>=0.0.8
+Requires-Dist: pydantic>=2.0.0
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Dynamic: license-file
+
+# ovos-PHAL-plugin-tools
+
+A PHAL (Platform / Hardware Abstraction Layer) service provider that exposes all
+installed OPM **ToolBox** plugins (`opm.agents.toolbox` entry-point group) as a
+unified bus API.
+
+Any skill, agent, or external client connected to the OVOS messagebus can:
+
+- enumerate every available tool and its JSON Schema
+- fetch a single tool's full schema
+- invoke a tool by name with keyword arguments
+
+---
+
+## Bus API reference
+
+All events follow the request → response pattern. The response event name is the
+request event name suffixed with `.response`.
+
+### `ovos.tools.list`
+
+Enumerate all tools registered across every loaded toolbox.
+
+| Field | Type | Required | Description |
+|-------|------|----------|-------------|
+| *(no payload fields)* | | | |
+
+**Response: `ovos.tools.list.response`**
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `tools` | `list[ToolEntry]` | All discovered tools |
+
+**ToolEntry fields:**
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `name` | `str` | Unique tool name (snake_case) |
+| `description` | `str` | Natural-language description |
+| `argument_schema` | `dict` | JSON Schema for call arguments |
+| `output_schema` | `dict` | JSON Schema for the return value |
+| `toolbox_id` | `str` | Originating toolbox entry-point name |
+
+**Example response payload:**
+
+```json
+{
+  "tools": [
+    {
+      "name": "add",
+      "description": "Add two integers.",
+      "argument_schema": {
+        "title": "AddArgs",
+        "type": "object",
+        "properties": {
+          "a": {"title": "A", "type": "integer"},
+          "b": {"title": "B", "type": "integer"}
+        },
+        "required": ["a", "b"]
+      },
+      "output_schema": {
+        "title": "AddOutput",
+        "type": "object",
+        "properties": {
+          "result": {"title": "Result", "type": "integer"}
+        },
+        "required": ["result"]
+      },
+      "toolbox_id": "math_tools"
+    }
+  ]
+}
+```
+
+---
+
+### `ovos.tools.get`
+
+Retrieve the full schema of a single named tool.
+
+**Request payload:**
+
+| Field | Type | Required | Description |
+|-------|------|----------|-------------|
+| `name` | `str` | yes | The snake_case tool name |
+
+**Response: `ovos.tools.get.response`**
+
+Success:
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `name` | `str` | Tool name |
+| `description` | `str` | Natural-language description |
+| `argument_schema` | `dict` | JSON Schema for call arguments |
+| `output_schema` | `dict` | JSON Schema for return value |
+| `toolbox_id` | `str` | Originating toolbox |
+
+Error (unknown tool or missing `name`):
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `error` | `str` | Human-readable error message |
+
+**Example:**
+
+```json
+// request
+{"name": "add"}
+
+// response (success)
+{
+  "name": "add",
+  "description": "Add two integers.",
+  "argument_schema": { ... },
+  "output_schema":   { ... },
+  "toolbox_id": "math_tools"
+}
+
+// response (error)
+{"error": "Unknown tool: 'nonexistent'"}
+```
+
+---
+
+### `ovos.tools.invoke`
+
+Execute a tool synchronously and receive its result.
+
+**Request payload:**
+
+| Field | Type | Required | Description |
+|-------|------|----------|-------------|
+| `name` | `str` | yes | The snake_case tool name |
+| `args` | `dict` | yes | Keyword arguments matching the tool's `argument_schema` |
+
+**Response: `ovos.tools.invoke.response`**
+
+Success:
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `name` | `str` | Tool name (echoed) |
+| `result` | `dict` | Tool output, matching `output_schema` |
+
+Error:
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `name` | `str` | Tool name (echoed) |
+| `error` | `str` | `ExceptionType: message` |
+
+**Example:**
+
+```json
+// request
+{"name": "add", "args": {"a": 3, "b": 4}}
+
+// response (success)
+{"name": "add", "result": {"result": 7}}
+
+// response (error — bad args)
+{"name": "add", "error": "ValueError: Tool input validation failed for 'add' ..."}
+
+// response (error — unknown tool)
+{"name": "nope", "error": "Unknown tool: 'nope'"}
+```
+
+---
+
+### `ovos.tools.reload`
+
+Hot-reload the toolbox registry without restarting OVOS.  Useful after
+installing new toolbox plugins at runtime.
+
+**Request payload:** *(none)*
+
+**Response: `ovos.tools.reload.response`**
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `loaded` | `list[str]` | Toolbox entry-point names now loaded |
+| `total_tools` | `int` | Total number of tools across all toolboxes |
+
+---
+
+## Third-party usage example
+
+```python
+from ovos_bus_client import MessageBusClient, Message
+
+bus = MessageBusClient()
+bus.run_in_thread()
+
+# --- list all tools ---
+response = bus.wait_for_response(Message("ovos.tools.list"))
+for tool in response.data["tools"]:
+    print(tool["name"], "—", tool["description"])
+
+# --- get schema for one tool ---
+response = bus.wait_for_response(
+    Message("ovos.tools.get", {"name": "add"})
+)
+print(response.data)
+
+# --- invoke a tool ---
+response = bus.wait_for_response(
+    Message("ovos.tools.invoke", {"name": "add", "args": {"a": 10, "b": 32}})
+)
+if "error" in response.data:
+    print("Error:", response.data["error"])
+else:
+    print("Result:", response.data["result"])
+```
+
+---
+
+## Installation
+
+```bash
+pip install ovos-PHAL-plugin-tools
+```
+
+Enable in your OVOS config (`mycroft.conf`):
+
+```json
+{
+  "PHAL": {
+    "ovos-phal-plugin-tools": {
+      "enabled": true
+    }
+  }
+}
+```
+
+Install one or more toolbox plugins (entry-point group `opm.agents.toolbox`) and
+the service will discover them automatically at startup.  Call
+`ovos.tools.reload` if you install plugins while OVOS is already running.
+
+---
+
+## Writing a ToolBox plugin
+
+Implement `ovos_plugin_manager.templates.agent_tools.ToolBox` and register under
+the `opm.agents.toolbox` entry-point group in your package's `pyproject.toml`:
+
+```toml
+[project.entry-points."opm.agents.toolbox"]
+my-math-tools = "my_package.toolbox:MyMathToolBox"
+```
+
+```python
+from typing import List
+from pydantic import Field
+from ovos_plugin_manager.templates.agent_tools import (
+    AgentTool, ToolArguments, ToolOutput, ToolBox,
+)
+
+
+class AddArgs(ToolArguments):
+    a: int = Field(..., description="First operand")
+    b: int = Field(..., description="Second operand")
+
+
+class AddOutput(ToolOutput):
+    result: int = Field(..., description="Sum")
+
+
+class MyMathToolBox(ToolBox):
+    def discover_tools(self) -> List[AgentTool]:
+        return [
+            AgentTool(
+                name="add",
+                description="Add two integers.",
+                argument_schema=AddArgs,
+                output_schema=AddOutput,
+                tool_call=lambda args: AddOutput(result=args.a + args.b),
+            )
+        ]
+```
+
+---
+
+## License
+
+Apache 2.0 — see [LICENSE](LICENSE).
+
+## Credits
+
+Developed by [TigreGotico](https://tigregotico.pt) for [OpenVoiceOS](https://openvoiceos.org).
+
+Funded by [NGI0 Commons Fund](https://nlnet.nl/project/OpenVoiceOS) / [NLnet](https://nlnet.nl)
+under grant agreement No [101135429](https://cordis.europa.eu/project/id/101135429),
+through the European Commission's [Next Generation Internet](https://ngi.eu) programme.

ovos_phal_plugin_tools-0.0.1a1/README.md

@@ -0,0 +1,294 @@
+# ovos-PHAL-plugin-tools
+
+A PHAL (Platform / Hardware Abstraction Layer) service provider that exposes all
+installed OPM **ToolBox** plugins (`opm.agents.toolbox` entry-point group) as a
+unified bus API.
+
+Any skill, agent, or external client connected to the OVOS messagebus can:
+
+- enumerate every available tool and its JSON Schema
+- fetch a single tool's full schema
+- invoke a tool by name with keyword arguments
+
+---
+
+## Bus API reference
+
+All events follow the request → response pattern. The response event name is the
+request event name suffixed with `.response`.
+
+### `ovos.tools.list`
+
+Enumerate all tools registered across every loaded toolbox.
+
+| Field | Type | Required | Description |
+|-------|------|----------|-------------|
+| *(no payload fields)* | | | |
+
+**Response: `ovos.tools.list.response`**
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `tools` | `list[ToolEntry]` | All discovered tools |
+
+**ToolEntry fields:**
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `name` | `str` | Unique tool name (snake_case) |
+| `description` | `str` | Natural-language description |
+| `argument_schema` | `dict` | JSON Schema for call arguments |
+| `output_schema` | `dict` | JSON Schema for the return value |
+| `toolbox_id` | `str` | Originating toolbox entry-point name |
+
+**Example response payload:**
+
+```json
+{
+  "tools": [
+    {
+      "name": "add",
+      "description": "Add two integers.",
+      "argument_schema": {
+        "title": "AddArgs",
+        "type": "object",
+        "properties": {
+          "a": {"title": "A", "type": "integer"},
+          "b": {"title": "B", "type": "integer"}
+        },
+        "required": ["a", "b"]
+      },
+      "output_schema": {
+        "title": "AddOutput",
+        "type": "object",
+        "properties": {
+          "result": {"title": "Result", "type": "integer"}
+        },
+        "required": ["result"]
+      },
+      "toolbox_id": "math_tools"
+    }
+  ]
+}
+```
+
+---
+
+### `ovos.tools.get`
+
+Retrieve the full schema of a single named tool.
+
+**Request payload:**
+
+| Field | Type | Required | Description |
+|-------|------|----------|-------------|
+| `name` | `str` | yes | The snake_case tool name |
+
+**Response: `ovos.tools.get.response`**
+
+Success:
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `name` | `str` | Tool name |
+| `description` | `str` | Natural-language description |
+| `argument_schema` | `dict` | JSON Schema for call arguments |
+| `output_schema` | `dict` | JSON Schema for return value |
+| `toolbox_id` | `str` | Originating toolbox |
+
+Error (unknown tool or missing `name`):
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `error` | `str` | Human-readable error message |
+
+**Example:**
+
+```json
+// request
+{"name": "add"}
+
+// response (success)
+{
+  "name": "add",
+  "description": "Add two integers.",
+  "argument_schema": { ... },
+  "output_schema":   { ... },
+  "toolbox_id": "math_tools"
+}
+
+// response (error)
+{"error": "Unknown tool: 'nonexistent'"}
+```
+
+---
+
+### `ovos.tools.invoke`
+
+Execute a tool synchronously and receive its result.
+
+**Request payload:**
+
+| Field | Type | Required | Description |
+|-------|------|----------|-------------|
+| `name` | `str` | yes | The snake_case tool name |
+| `args` | `dict` | yes | Keyword arguments matching the tool's `argument_schema` |
+
+**Response: `ovos.tools.invoke.response`**
+
+Success:
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `name` | `str` | Tool name (echoed) |
+| `result` | `dict` | Tool output, matching `output_schema` |
+
+Error:
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `name` | `str` | Tool name (echoed) |
+| `error` | `str` | `ExceptionType: message` |
+
+**Example:**
+
+```json
+// request
+{"name": "add", "args": {"a": 3, "b": 4}}
+
+// response (success)
+{"name": "add", "result": {"result": 7}}
+
+// response (error — bad args)
+{"name": "add", "error": "ValueError: Tool input validation failed for 'add' ..."}
+
+// response (error — unknown tool)
+{"name": "nope", "error": "Unknown tool: 'nope'"}
+```
+
+---
+
+### `ovos.tools.reload`
+
+Hot-reload the toolbox registry without restarting OVOS.  Useful after
+installing new toolbox plugins at runtime.
+
+**Request payload:** *(none)*
+
+**Response: `ovos.tools.reload.response`**
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `loaded` | `list[str]` | Toolbox entry-point names now loaded |
+| `total_tools` | `int` | Total number of tools across all toolboxes |
+
+---
+
+## Third-party usage example
+
+```python
+from ovos_bus_client import MessageBusClient, Message
+
+bus = MessageBusClient()
+bus.run_in_thread()
+
+# --- list all tools ---
+response = bus.wait_for_response(Message("ovos.tools.list"))
+for tool in response.data["tools"]:
+    print(tool["name"], "—", tool["description"])
+
+# --- get schema for one tool ---
+response = bus.wait_for_response(
+    Message("ovos.tools.get", {"name": "add"})
+)
+print(response.data)
+
+# --- invoke a tool ---
+response = bus.wait_for_response(
+    Message("ovos.tools.invoke", {"name": "add", "args": {"a": 10, "b": 32}})
+)
+if "error" in response.data:
+    print("Error:", response.data["error"])
+else:
+    print("Result:", response.data["result"])
+```
+
+---
+
+## Installation
+
+```bash
+pip install ovos-PHAL-plugin-tools
+```
+
+Enable in your OVOS config (`mycroft.conf`):
+
+```json
+{
+  "PHAL": {
+    "ovos-phal-plugin-tools": {
+      "enabled": true
+    }
+  }
+}
+```
+
+Install one or more toolbox plugins (entry-point group `opm.agents.toolbox`) and
+the service will discover them automatically at startup.  Call
+`ovos.tools.reload` if you install plugins while OVOS is already running.
+
+---
+
+## Writing a ToolBox plugin
+
+Implement `ovos_plugin_manager.templates.agent_tools.ToolBox` and register under
+the `opm.agents.toolbox` entry-point group in your package's `pyproject.toml`:
+
+```toml
+[project.entry-points."opm.agents.toolbox"]
+my-math-tools = "my_package.toolbox:MyMathToolBox"
+```
+
+```python
+from typing import List
+from pydantic import Field
+from ovos_plugin_manager.templates.agent_tools import (
+    AgentTool, ToolArguments, ToolOutput, ToolBox,
+)
+
+
+class AddArgs(ToolArguments):
+    a: int = Field(..., description="First operand")
+    b: int = Field(..., description="Second operand")
+
+
+class AddOutput(ToolOutput):
+    result: int = Field(..., description="Sum")
+
+
+class MyMathToolBox(ToolBox):
+    def discover_tools(self) -> List[AgentTool]:
+        return [
+            AgentTool(
+                name="add",
+                description="Add two integers.",
+                argument_schema=AddArgs,
+                output_schema=AddOutput,
+                tool_call=lambda args: AddOutput(result=args.a + args.b),
+            )
+        ]
+```
+
+---
+
+## License
+
+Apache 2.0 — see [LICENSE](LICENSE).
+
+## Credits
+
+Developed by [TigreGotico](https://tigregotico.pt) for [OpenVoiceOS](https://openvoiceos.org).
+
+Funded by [NGI0 Commons Fund](https://nlnet.nl/project/OpenVoiceOS) / [NLnet](https://nlnet.nl)
+under grant agreement No [101135429](https://cordis.europa.eu/project/id/101135429),
+through the European Commission's [Next Generation Internet](https://ngi.eu) programme.