thingagent 0.1.1__tar.gz

thingagent-0.1.1/LICENSE

@@ -0,0 +1,204 @@
+Copyright 2026 The thingctx Authors
+
+
+                                 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, whether in Source or
+      Object form, 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 modifications
+      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 any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to 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 discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated 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 patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   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 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, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, 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. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   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.

thingagent-0.1.1/PKG-INFO

@@ -0,0 +1,299 @@
+Metadata-Version: 2.4
+Name: thingagent
+Version: 0.1.1
+Summary: Distributed runtime for AI agents in the physical world, governed by policy: which agent, which device, which operation, and within which limits.
+Author: The thingagent Authors
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://thingctx.com
+Project-URL: Source, https://github.com/thingctx/thingagent
+Project-URL: Issues, https://github.com/thingctx/thingagent/issues
+Project-URL: Security, https://github.com/thingctx/thingagent/security/advisories/new
+Keywords: web of things,wot,thing description,agents,llm,iot,robotics,mqtt
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Home Automation
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: System :: Networking
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: thingctx[authz,http,model,mqtt,validate]<0.4,>=0.3
+Provides-Extra: llm
+Requires-Dist: thingctx[llm]<0.4,>=0.3; extra == "llm"
+Provides-Extra: ros
+Requires-Dist: thingctx[ros]<0.4,>=0.3; extra == "ros"
+Provides-Extra: mcp
+Requires-Dist: thingctx[mcp]<0.4,>=0.3; extra == "mcp"
+Provides-Extra: dev
+Requires-Dist: thingctx[llm,mcp]<0.4,>=0.3; extra == "dev"
+Requires-Dist: pytest>=7; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21; extra == "dev"
+Requires-Dist: pyjwt[crypto]>=2.8; extra == "dev"
+Requires-Dist: jsonschema>=4.0; extra == "dev"
+Requires-Dist: ruff==0.16.8; extra == "dev"
+Requires-Dist: mypy==2.3.1; extra == "dev"
+Requires-Dist: vulture==2.14; extra == "dev"
+Dynamic: license-file
+
+# thingagent
+
+thingagent is a distributed runtime for AI agents in the physical world,
+governed by policy. Every call an agent makes, to a robot arm, a lock or a
+lamp, is decided by which agent is calling, which device, which operation, and
+within which limits. Calls the policy refuses never reach the device.
+
+Agents and the gateways in front of devices run on different hosts, joined by
+an MQTT broker, or all in one process. Each agent is defined in a JSON file:
+what it reads, what it may do, and within which limits. Every decision can be
+recorded.
+
+## Install
+
+Python 3.10 or later.
+
+    pip install thingagent
+
+| Extra | Adds |
+| --- | --- |
+| `llm` | A model behind the agents, through litellm. |
+| `ros` | ROS 2 robots behind rosbridge. |
+| `mcp` | The `thingagent mcp` command. |
+
+## First run
+
+One heater and one agent, in this process, with a scripted model. It needs no
+key, no broker and no network:
+
+```python
+import asyncio
+
+from thingctx.bindings import LocalBinding
+
+from thingagent import Agent, Harness
+
+heater = {
+    "@context": "https://www.w3.org/2022/wot/td/v1.1",
+    "id": "urn:example:heater",
+    "title": "Heater",
+    "securityDefinitions": {"nosec_sc": {"scheme": "nosec"}},
+    "security": ["nosec_sc"],
+    "actions": {
+        "set_target": {
+            "input": {"type": "object", "properties": {"target": {"type": "number"}}},
+            "output": {"type": "object"},
+            "forms": [{"href": "local://set_target"}],
+        }
+    },
+}
+
+keeper = Agent.from_dict(
+    {
+        "name": "keeper",
+        "instructions": "You look after the house.",
+        "may": ["heater__set_target"],
+        "limits": {
+            "heater__set_target": {"properties": {"target": {"type": "number", "maximum": 24}}}
+        },
+    }
+)
+
+state = {"target": 18}
+device = LocalBinding()
+device.register_thing(
+    "heater",
+    {
+        "set_target": lambda target: state.update(target=target) or {"target": target},
+    },
+)
+
+
+def call(n, name, arguments):
+    tool = {
+        "id": f"call_{n}",
+        "type": "function",
+        "function": {"name": name, "arguments": arguments},
+    }
+    return {"role": "assistant", "content": None, "tool_calls": [tool]}
+
+
+turns = [
+    call(1, "heater__set_target", '{"target": 22}'),
+    call(2, "heater__set_target", '{"target": 30}'),
+    {"role": "assistant", "content": "Set the target to 22. The gate refused 30."},
+]
+
+
+async def scripted(messages, tools):
+    return turns.pop(0)
+
+
+async def main():
+    harness = Harness([keeper], fleet=[heater], bindings=[device], chat_fn=scripted)
+    await harness.start()
+    try:
+        did = await harness.do(keeper, "Warm the house up.")
+    finally:
+        await harness.aclose()
+    print(did["answer"])
+    for record in did["acted"]:
+        status = record["schema:actionStatus"]
+        print(
+            f"  {record['sosa:actsOnProperty']} {status} {record.get('dct:description', '')}".rstrip()
+        )
+    print("target:", state["target"])
+
+
+asyncio.run(main())
+```
+
+```
+Set the target to 22. The gate refused 30.
+  set_target schema:CompletedActionStatus
+  set_target schema:FailedActionStatus arguments outside the grant's limits for ('urn:example:heater', 'set_target', 'invokeaction'): target: 30 is greater than the maximum of 24
+target: 22
+```
+
+The first call ran. The second broke the agent's limit, so the gate refused it
+and the heater never saw it. Each record in `acted` says what happened, in W3C
+SOSA, PROV and schema.org terms. The `heater` dict is a W3C Thing Description;
+thingagent reaches devices through
+[thingctx](https://pypi.org/project/thingctx/), over HTTP, MQTT, ROS 2 or in
+process as here. Give the agent a `"model"` litellm accepts, install the `llm`
+extra, set the key, and drop `chat_fn` to put a real model behind it.
+
+## An agent
+
+Each agent is a JSON file. The keys: `name`; `model`; `instructions`; `reads`,
+the properties it may read; `may`, the actions it may take on a task; `limits`,
+a JSON Schema per action that its arguments must satisfy; `approve`, the
+question its `person` must answer yes to before an action runs; `approval`, the
+`timeout` and the `signal` and `clear` steps that show a question is waiting.
+A numeric bound in `limits` needs a `type` beside it, or the agent does not load.
+
+```json
+{
+  "name": "keeper",
+  "instructions": "You look after the house. Check the door before you act.",
+  "reads": ["door__locked", "thermostat__temperature"],
+  "may": ["door__lock", "door__unlock"],
+  "approve": {"door__unlock": "Unlock the front door?"},
+  "person": "alice"
+}
+```
+
+An agent runs in one of three modes. `do` runs a task: the model picks each
+call and its arguments, only among `may`, inside `limits`, and waits for its
+person on `approve`. `ask` answers a person from `reads` alone and cannot act.
+`decide` answers fixed `questions` about a trigger, and each answer maps to
+fixed steps in the `act` table; an answer outside the listed values is refused,
+so the model cannot name an action of its own:
+
+```json
+{
+  "name": "doorwatch",
+  "model": "openrouter/google/gemma-4-31b-it",
+  "questions": [{"type": "choice", "name": "who",
+                 "values": ["resident", "delivery", "stranger", "unclear"]}],
+  "act": {"who": {"stranger": [{"invoke": "door__lock"}]}},
+  "reads": ["door__locked"],
+  "image": "camera__snapshot",
+  "person": "alice"
+}
+```
+
+## Rules on device events
+
+A rule names one device event (or an observable property), the values its data
+must hold, and the agent action it calls: `<agent>__decide` with the event as
+the trigger, `<agent>__do` with a `task` in `args`, or `<agent>__approve` with
+a person's answer and the action it approves.
+
+```json
+{"name": "person_at_door", "event": "camera__person",
+ "when": {"label": "person"}, "calls": "keeper__do",
+ "args": {"task": "Someone is at the door. Lock it."}, "max_age": 30}
+```
+
+With `max_age`, an event whose time (at `time`, `at` by default) is missing or
+older than that many seconds starts nothing, so an event the broker held while
+thingagent was down does not move a device.
+
+## The configuration file
+
+Only `fleet` and `agents` are required. Paths are relative to the file. A
+secret never goes in it: every `*_env` key names an environment variable.
+
+```json
+{"fleet": ["things"], "agents": ["agents/keeper.json"], "rules": ["rules/door.json"],
+ "allow": {"alice": ["keeper"]}, "trace": "trace.jsonl"}
+```
+
+`fleet` holds TD files, folders of them or TD URLs, or `"bus"` with a `broker`
+(`host:port`, or `mqtts://host:port` for TLS) to read the TDs the fleet's
+gateways retain. `allow` maps a person to the agents they may chat with.
+`trace` is a JSON Lines file of every task, answer, decision and record. The
+logins, tokens, guard, policy and TLS keys for a broker are in the full README.
+
+## Commands
+
+    thingagent check CONFIG
+    thingagent generate CONFIG --out DIR [--gateway GATEWAY]
+    thingagent serve CONFIG
+    thingagent chat CONFIG --as PERSON
+    thingagent do CONFIG AGENT TASK [--as PERSON]
+    thingagent ask CONFIG AGENT PROMPT
+    thingagent gateway GATEWAY
+    thingagent mcp CONFIG CLIENT
+
+`check` reports an affordance the fleet lacks, a name used twice, a rule that
+calls no agent action, and a broker setup that would let an agent act on an
+open bus; `serve`, `chat`, `do`, `ask` and `mcp` refuse to start while it
+reports a problem. `generate` writes `DIR/grants.json` for the fleet gateway
+and `DIR/acl` for a Mosquitto broker. `serve` runs the agents and their rules
+until stopped; `chat` adds a chat in this terminal, where a person in `allow`
+writes `@keeper lock the door` to give the agent a task. `do` and `ask` run one
+task or one prompt. With a broker, `gateway` serves the devices from its own
+configuration file (`broker`, `things`, `login`, `guard`, `grants`, `trace`)
+and `mcp` serves the fleet to an MCP client over stdio as one of the `clients`
+in the configuration. An agent with a `model` needs the model's key in the
+environment, and a litellm model needs the `llm` extra; `gateway` and `mcp`
+need a broker.
+
+## Python API
+
+`thingagent` exports `Agent`, `Harness`, `Rule`, `check`, `grants`, the
+deciders and `ChatChannel`.
+
+- `Agent.from_dict(raw)` or `Agent.load(path)` reads an agent file; a limit or
+  approval on an action the agent may not take raises `ValueError`. `agent.td()`
+  is the Thing Description it is served under.
+- `Rule.from_dict(raw)` or `Rule.load(path)`.
+- `check(agents, rules, fleet)` returns every problem as a sentence; an empty
+  list means none. `grants(agents, rules, fleet)` returns each name's least
+  privilege grants, in the form thingctx's policy decision point takes.
+- `Harness(agents, fleet=tds, bindings=..., rules=..., chat_fn=..., decider=...,
+  trace=...)`, then `await harness.start()`. `await harness.do(agent, task,
+  person=None)` returns the answer and the records in `acted`;
+  `await harness.ask(agent, prompt)` returns `{"answer": ...}`;
+  `await harness.decide(agent, trigger)` returns the answers and what ran.
+  `await harness.channel.receive(person, text)` delivers a person's message or
+  their yes or no. Close with `await harness.aclose()`. With `broker=`, the
+  harness serves the agents on the bus and calls the fleet through its gateway.
+- `Decider` is the protocol a `decide` agent answers through,
+  `await answer(agent, context, image)`. `ChatDecider` asks a chat model through
+  litellm; `DecisionsDecider` asks OpenRouter's Decisions API for a
+  `decisions/...` model. `checked(question, raw)` turns an answer outside the
+  question's values into a refusal.
+
+## Docs and source
+
+Full README, the fleet gateway, approvals, limits and `thingagent mcp`:
+https://github.com/thingctx/thingagent
+
+Apache-2.0