clickhouse-loom 1.1.0__tar.gz

clickhouse_loom-1.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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 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 directory name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 ClickHouse, Inc.
+
+   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.

clickhouse_loom-1.1.0/PKG-INFO

@@ -0,0 +1,191 @@
+Metadata-Version: 2.5
+Name: clickhouse-loom
+Version: 1.1.0
+Summary: Python SDK for Loom — shared-production agent memory, knowledge, conflict, and observability plane on ClickHouse.
+Project-URL: Homepage, https://github.com/ClickHouse/loom
+Project-URL: Repository, https://github.com/ClickHouse/loom
+Project-URL: Issues, https://github.com/ClickHouse/loom/issues
+Author: ClickHouse, Inc.
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: agent,ai,clickhouse,llm,loom,mcp,memory
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: httpx[http2]>=0.27
+Provides-Extra: aws
+Requires-Dist: boto3>=1.28; extra == 'aws'
+Requires-Dist: pyjwt[crypto]>=2.8; extra == 'aws'
+Provides-Extra: machine
+Requires-Dist: pyjwt[crypto]>=2.8; extra == 'machine'
+Description-Content-Type: text/markdown
+
+# clickhouse-loom
+
+Python SDK for [Loom](https://github.com/ClickHouse/loom) — the shared-production memory, knowledge, conflict, and observability data plane for AI agents, built on ClickHouse.
+
+This package contains the **client SDK only**. Loom is designed for shared production deployment: an operator runs the server (Docker image at `ghcr.io/clickhouse/loom`) against a real ClickHouse instance (Cloud or self-hosted OSS), then application developers like you use this SDK to talk to it.
+
+## Install
+
+Not on PyPI yet, so install from source — pure Python, no build step — or from
+the wheel attached to a GitHub Release
+([docs/development/release-process.md](https://github.com/ClickHouse/loom/blob/main/docs/development/release-process.md#installing-from-a-github-release)):
+
+```bash
+pip install ./sdk/python                     # from a clone of ClickHouse/loom
+# without a clone (needs the same GitHub access as `git clone`):
+pip install "clickhouse-loom @ git+https://github.com/ClickHouse/loom#subdirectory=sdk/python"
+```
+
+<!-- restore `pip install clickhouse-loom` when release.yml publishes -->
+
+Python 3.11+. Runtime deps: `httpx[http2]` (HTTP/2 via `h2`).
+
+## Use
+
+You'll need:
+
+- A `base_url` pointing at your team's Loom deployment.
+- A credential. Either sign in once with `python -m loom login --server <url>` (or `loom.login(url)` in a notebook), approving on any browser with your password or SSO; every `Agent` you point at that server (`base_url=` or `LOOM_BASE_URL`) then uses that session and refreshes it. Or use a JWT your operator mints (`POST /v1/admin/token.mint`, `loom mint-token`), passed as `api_key=` or `LOOM_API_KEY` — the right choice for CI and services.
+
+```python
+from loom import Datapack
+import os
+
+dp = Datapack(
+    org="clickhouse",
+    namespace="eng-tooling",
+    base_url=os.environ["LOOM_BASE_URL"],  # e.g. https://loom.example.com
+    api_key=os.environ["LOOM_API_KEY"],  # JWT from your operator
+)
+
+agent = dp.agent("claude-desktop")
+
+# Save a memory
+await agent.memory.set(
+    memory_key="deploy_window",
+    value="Deploy Tue/Thu, never Friday",
+    memory_type="preference",
+)
+
+# Recall by key
+got = await agent.memory.get(memory_key="deploy_window")
+
+# Or semantic search
+hits = await agent.memory.search("when do we deploy")
+```
+
+The `Agent` exposes 27 client modules: `client`, `account`, `deployment`, `memory`, `working_memory`, `knowledge`, `conversations`, `profile`, `context`, `facts`, `learnings`, `conflicts`, `blacklist`, `grants`, `erasure`, `cost`, `audit`, `namespaces`, `procedure`, `run`, `tasks`, `policy`, `decision`, `calibration`, `briefs`, `code`, `tracker`. Each of the named ones is the hand-written layer over a wire-op group on the Loom server (`account` and `deployment` cover the routes outside the op registry: service accounts, MCP setup, model settings, worker health); `client` holds every served op as a generated method (below).
+
+Full guide: [docs/reference/python-sdk.md](https://github.com/ClickHouse/loom/blob/main/docs/reference/python-sdk.md). Deployment paths (how an operator stands up the server): [docs/operations/deployment.md](https://github.com/ClickHouse/loom/blob/main/docs/operations/deployment.md).
+
+## Every op by name, any op by call, a probe before you rely
+
+`loom.ops` is generated from the server's operation registry: `OPS` (name → idempotency, required role, maturity, latency budget), `OpName`, and one `TypedDict` per request / response (`MemorySearchInput`, …) with `Required[...]` on the fields the server requires — names for your editor and type checker while the SDK stays dict-in / dict-out. `MemorySearchBody` is the same shape with the identity keys (`org`, `namespace`, `agent`, `user_id`, `session_id`, `run_id`) optional: what you write when `agent.call` stamps the identity for you.
+
+`agent.client` has one method per served op, generated from the same registry: the group is the op name's first segment and the method the rest with `.` → `_`, so `tracker.source.add` is `agent.client.tracker.source_add({...})`. It takes the op's `<Op>Body`, returns its `<Op>Output`, and passes `user_id=`, `session_id=`, `timeout_s=` and the other `agent.call` options through. The TypeScript SDK exposes the same ops at the same group, camel-cased: `loom.tracker.sourceAdd({...})`; a unit test fails when the two differ.
+
+```python
+from loom.ops import OPS, MemorySearchBody
+
+body: MemorySearchBody = {"query": "deploy window", "top_k": 5, "exclude_keys": ["seen_1"]}
+out = await agent.call(
+    "memory.search", body, user_id="u-42"
+)  # identity stamped; Idempotency-Key when OPS says idempotent
+p = await agent.probe(
+    ops=["memory.ask", "context.pack"], fields={"memory.search": ["exclude_keys"]}
+)
+assert p["ok"], (p["missing_ops"], p["missing_fields"])
+print(OPS["memory.search"].idempotent, OPS["memory.search"].role)
+```
+
+`agent.memory.search(...)` and `agent.knowledge.search(...)` also accept `**extra`, so a field the server shipped this week rides the body without an SDK release. Errors are typed by the server's `detail.code`, and by HTTP status when a body carries none: `NotFound`, `ValidationError`, `AuthInvalid`, `AuthInsufficient`, `PreconditionFailed`, `RateLimited`, `BackendUnavailable` — every one carries `.request_id` (the `X-Request-Id` the server echoed) and `.status`.
+
+`await agent.capabilities()` pairs `ops.capabilities` with what the bearer token itself says (`roles` / `ns_roles`, decoded, not verified) so an integration does not poll ops its token cannot call: `caps.can_call("conflicts.list")` is `True` / `False` when known and `None` when the SDK cannot tell — then make the call; `await agent.can_call(op)` answers for the Agent's namespace; `caps.callable()` lists every served op the token may call. Cached 60 s.
+
+`agent.call_with_meta(...)` is the same call returning a `CallResult`: `.data`, `.request_id` (finds the call in the server's ledger), `.schema_version`, `.server_timing_ms`, `.rate_limit` and `.attempts`. Every request identifies itself (`User-Agent` / `X-Loom-SDK: loom-py/<version>`, `X-Loom-Runtime`, `X-Loom-Retry-Count`); `Retry-After` is honoured as seconds or an HTTP-date. The credential never appears in `repr(agent.transport)` (it shows `api_key=…1234`), and a blank `LOOM_API_KEY` is treated as unset. The package ships `py.typed` and passes `mypy --strict`.
+
+## Give your agent the guide
+
+`await agent.guide()` returns how to use Loom, written for a model: the loop,
+where each kind of state goes and how to read what comes back
+(the experimental `mentor.guide`, the `loom` skill in `skills/loom/`). Put it in the system
+prompt of an agent that has no plugin to carry it; `part="reference"` returns
+every plane with its ops.
+
+```python
+system_prompt = "You triage support tickets.\n\n" + await agent.guide()
+```
+
+## Ask the mentor
+
+The store reads what your agent actually calls and names the planes it never
+uses — the code index, the tracker source, documents, records, offload,
+the entity graph — with the counts behind each hint. Two channels need nothing
+from you: every successful response may carry one `X-Loom-Hint`, which the
+transport logs at INFO once per distinct text and exposes as
+`CallResult.hint`, and a `context.pack` at session start carries up to three
+hints. A bot that never renders a pack asks once at startup:
+
+```python
+async with Agent(org="acme", namespace="support", agent="triage-bot") as bot:
+    brief = await bot.mentor()  # logs up to three hints; returns the brief
+    for h in brief["hints"]:
+        print(h["code"], h["severity"], h["text"], h["evidence"])
+```
+
+`mentor_brief=True` (or `LOOM_MENTOR_BRIEF=on`) runs it in the background on
+the first call instead. Name your agent: `""`, `"-"` and `"*"` default to
+`sdk-python:<script>` with a warning, because an anonymous agent is every
+other anonymous caller to the ledger, the mentor and the cost views.
+
+## Sessions and tools: what an agent framework holds
+
+`agent.session(id, user_id=...)` binds one (user, session) scope to the verbs an agent loop needs between turns: `resume()` returns the context pack as `system` plus the transcript tail as `messages`; `append(*turns)` writes the transcript now and runs `memory.set_from_messages` every `flush_every` turns; `offload()` / `fetch()` park a large tool result and read it back by pattern; `note()` appends to working memory; `close()` flushes. It is an async context manager; `SyncAgent.session()` blocks.
+
+```python
+async with agent.session("thread-42", user_id="u1") as s:
+    resumed = await s.resume(query="resume the billing migration")
+    system_prompt, history = resumed.system, resumed.messages
+    await s.append({"role": "user", "content": text}, {"role": "assistant", "content": reply})
+    blob = await s.offload(build_log, summary="pytest run 812")
+    await s.note(blob["pointer"])
+```
+
+`agent.tools(user_id=..., session_id=...)` gives a model six loom verbs — `loom_remember`, `loom_recall`, `loom_ask`, `loom_offload`, `loom_fetch`, `loom_note` — as `definitions("openai" | "anthropic" | "generic")` and one `await execute(name, arguments)` that returns the string the model reads. The schemas are the same as the TypeScript SDK's.
+
+## Retries and logging
+
+The retry policy is one frozen dataclass, set on the Agent and overridable per call with a `RetryPolicy` or a dict of its fields; every field is validated and named when wrong. Defaults: 3 attempts; 0.1 s backoff doubling to 5 s with ±25 % jitter; 408 and 5xx retried for registry-idempotent ops (any other op only on a 408 or a 503 `AUTH_UNAVAILABLE`, which the server answers before running it); connection errors retried; a read timeout retried only when the registry marks the op idempotent (the server dedups its `Idempotency-Key`); a `Retry-After` on a retried status honoured up to 60 s. A 429 is paced, not retried.
+
+```python
+from loom import Agent, RetryPolicy
+
+agent = Agent(
+    "acme",
+    "support",
+    "bot",
+    retry=RetryPolicy(max_attempts=5, total_backoff_budget_s=30),
+    consumer="support-bot",
+)  # the label every ledger row carries
+await agent.call("memory.get", memory_key="k", retry={"max_attempts": 1})  # this call: no retries
+await agent.call("memory.set_from_messages", messages=msgs, retry={"retry_timeouts": "always"})
+```
+
+The SDK logs through the stdlib logger `loom` (a `NullHandler` by default; your logging config routes it): one line per completed call at INFO (`/v1/memory.get 200 12 ms attempts=2 rid=…`), retries and rate-limit waits at WARNING, the final failure at ERROR, the request headers at DEBUG. `LOOM_LOG_LEVEL` (any stdlib level name — `debug`, `info`, `warning`, `error`, `critical` — or `off`) sets the logger's level when your application has not; a value it cannot read is a warning, not an import error. Credential headers are redacted to their scheme and last four characters, and a filter on the logger rewrites any bearer token that reaches a record anyway.
+
+## Examples
+
+[`examples/agent_memory.py`](./examples/agent_memory.py) — probe → remember ×3 → recall → ask with citations → outcome → typed errors, with its actual run in [`examples/README.md`](./examples/README.md). The TypeScript SDK ships the same example.
+
+## License
+
+Apache-2.0. See [LICENSE](https://github.com/ClickHouse/loom/blob/main/LICENSE).

clickhouse_loom-1.1.0/README.md

@@ -0,0 +1,162 @@
+# clickhouse-loom
+
+Python SDK for [Loom](https://github.com/ClickHouse/loom) — the shared-production memory, knowledge, conflict, and observability data plane for AI agents, built on ClickHouse.
+
+This package contains the **client SDK only**. Loom is designed for shared production deployment: an operator runs the server (Docker image at `ghcr.io/clickhouse/loom`) against a real ClickHouse instance (Cloud or self-hosted OSS), then application developers like you use this SDK to talk to it.
+
+## Install
+
+Not on PyPI yet, so install from source — pure Python, no build step — or from
+the wheel attached to a GitHub Release
+([docs/development/release-process.md](https://github.com/ClickHouse/loom/blob/main/docs/development/release-process.md#installing-from-a-github-release)):
+
+```bash
+pip install ./sdk/python                     # from a clone of ClickHouse/loom
+# without a clone (needs the same GitHub access as `git clone`):
+pip install "clickhouse-loom @ git+https://github.com/ClickHouse/loom#subdirectory=sdk/python"
+```
+
+<!-- restore `pip install clickhouse-loom` when release.yml publishes -->
+
+Python 3.11+. Runtime deps: `httpx[http2]` (HTTP/2 via `h2`).
+
+## Use
+
+You'll need:
+
+- A `base_url` pointing at your team's Loom deployment.
+- A credential. Either sign in once with `python -m loom login --server <url>` (or `loom.login(url)` in a notebook), approving on any browser with your password or SSO; every `Agent` you point at that server (`base_url=` or `LOOM_BASE_URL`) then uses that session and refreshes it. Or use a JWT your operator mints (`POST /v1/admin/token.mint`, `loom mint-token`), passed as `api_key=` or `LOOM_API_KEY` — the right choice for CI and services.
+
+```python
+from loom import Datapack
+import os
+
+dp = Datapack(
+    org="clickhouse",
+    namespace="eng-tooling",
+    base_url=os.environ["LOOM_BASE_URL"],  # e.g. https://loom.example.com
+    api_key=os.environ["LOOM_API_KEY"],  # JWT from your operator
+)
+
+agent = dp.agent("claude-desktop")
+
+# Save a memory
+await agent.memory.set(
+    memory_key="deploy_window",
+    value="Deploy Tue/Thu, never Friday",
+    memory_type="preference",
+)
+
+# Recall by key
+got = await agent.memory.get(memory_key="deploy_window")
+
+# Or semantic search
+hits = await agent.memory.search("when do we deploy")
+```
+
+The `Agent` exposes 27 client modules: `client`, `account`, `deployment`, `memory`, `working_memory`, `knowledge`, `conversations`, `profile`, `context`, `facts`, `learnings`, `conflicts`, `blacklist`, `grants`, `erasure`, `cost`, `audit`, `namespaces`, `procedure`, `run`, `tasks`, `policy`, `decision`, `calibration`, `briefs`, `code`, `tracker`. Each of the named ones is the hand-written layer over a wire-op group on the Loom server (`account` and `deployment` cover the routes outside the op registry: service accounts, MCP setup, model settings, worker health); `client` holds every served op as a generated method (below).
+
+Full guide: [docs/reference/python-sdk.md](https://github.com/ClickHouse/loom/blob/main/docs/reference/python-sdk.md). Deployment paths (how an operator stands up the server): [docs/operations/deployment.md](https://github.com/ClickHouse/loom/blob/main/docs/operations/deployment.md).
+
+## Every op by name, any op by call, a probe before you rely
+
+`loom.ops` is generated from the server's operation registry: `OPS` (name → idempotency, required role, maturity, latency budget), `OpName`, and one `TypedDict` per request / response (`MemorySearchInput`, …) with `Required[...]` on the fields the server requires — names for your editor and type checker while the SDK stays dict-in / dict-out. `MemorySearchBody` is the same shape with the identity keys (`org`, `namespace`, `agent`, `user_id`, `session_id`, `run_id`) optional: what you write when `agent.call` stamps the identity for you.
+
+`agent.client` has one method per served op, generated from the same registry: the group is the op name's first segment and the method the rest with `.` → `_`, so `tracker.source.add` is `agent.client.tracker.source_add({...})`. It takes the op's `<Op>Body`, returns its `<Op>Output`, and passes `user_id=`, `session_id=`, `timeout_s=` and the other `agent.call` options through. The TypeScript SDK exposes the same ops at the same group, camel-cased: `loom.tracker.sourceAdd({...})`; a unit test fails when the two differ.
+
+```python
+from loom.ops import OPS, MemorySearchBody
+
+body: MemorySearchBody = {"query": "deploy window", "top_k": 5, "exclude_keys": ["seen_1"]}
+out = await agent.call(
+    "memory.search", body, user_id="u-42"
+)  # identity stamped; Idempotency-Key when OPS says idempotent
+p = await agent.probe(
+    ops=["memory.ask", "context.pack"], fields={"memory.search": ["exclude_keys"]}
+)
+assert p["ok"], (p["missing_ops"], p["missing_fields"])
+print(OPS["memory.search"].idempotent, OPS["memory.search"].role)
+```
+
+`agent.memory.search(...)` and `agent.knowledge.search(...)` also accept `**extra`, so a field the server shipped this week rides the body without an SDK release. Errors are typed by the server's `detail.code`, and by HTTP status when a body carries none: `NotFound`, `ValidationError`, `AuthInvalid`, `AuthInsufficient`, `PreconditionFailed`, `RateLimited`, `BackendUnavailable` — every one carries `.request_id` (the `X-Request-Id` the server echoed) and `.status`.
+
+`await agent.capabilities()` pairs `ops.capabilities` with what the bearer token itself says (`roles` / `ns_roles`, decoded, not verified) so an integration does not poll ops its token cannot call: `caps.can_call("conflicts.list")` is `True` / `False` when known and `None` when the SDK cannot tell — then make the call; `await agent.can_call(op)` answers for the Agent's namespace; `caps.callable()` lists every served op the token may call. Cached 60 s.
+
+`agent.call_with_meta(...)` is the same call returning a `CallResult`: `.data`, `.request_id` (finds the call in the server's ledger), `.schema_version`, `.server_timing_ms`, `.rate_limit` and `.attempts`. Every request identifies itself (`User-Agent` / `X-Loom-SDK: loom-py/<version>`, `X-Loom-Runtime`, `X-Loom-Retry-Count`); `Retry-After` is honoured as seconds or an HTTP-date. The credential never appears in `repr(agent.transport)` (it shows `api_key=…1234`), and a blank `LOOM_API_KEY` is treated as unset. The package ships `py.typed` and passes `mypy --strict`.
+
+## Give your agent the guide
+
+`await agent.guide()` returns how to use Loom, written for a model: the loop,
+where each kind of state goes and how to read what comes back
+(the experimental `mentor.guide`, the `loom` skill in `skills/loom/`). Put it in the system
+prompt of an agent that has no plugin to carry it; `part="reference"` returns
+every plane with its ops.
+
+```python
+system_prompt = "You triage support tickets.\n\n" + await agent.guide()
+```
+
+## Ask the mentor
+
+The store reads what your agent actually calls and names the planes it never
+uses — the code index, the tracker source, documents, records, offload,
+the entity graph — with the counts behind each hint. Two channels need nothing
+from you: every successful response may carry one `X-Loom-Hint`, which the
+transport logs at INFO once per distinct text and exposes as
+`CallResult.hint`, and a `context.pack` at session start carries up to three
+hints. A bot that never renders a pack asks once at startup:
+
+```python
+async with Agent(org="acme", namespace="support", agent="triage-bot") as bot:
+    brief = await bot.mentor()  # logs up to three hints; returns the brief
+    for h in brief["hints"]:
+        print(h["code"], h["severity"], h["text"], h["evidence"])
+```
+
+`mentor_brief=True` (or `LOOM_MENTOR_BRIEF=on`) runs it in the background on
+the first call instead. Name your agent: `""`, `"-"` and `"*"` default to
+`sdk-python:<script>` with a warning, because an anonymous agent is every
+other anonymous caller to the ledger, the mentor and the cost views.
+
+## Sessions and tools: what an agent framework holds
+
+`agent.session(id, user_id=...)` binds one (user, session) scope to the verbs an agent loop needs between turns: `resume()` returns the context pack as `system` plus the transcript tail as `messages`; `append(*turns)` writes the transcript now and runs `memory.set_from_messages` every `flush_every` turns; `offload()` / `fetch()` park a large tool result and read it back by pattern; `note()` appends to working memory; `close()` flushes. It is an async context manager; `SyncAgent.session()` blocks.
+
+```python
+async with agent.session("thread-42", user_id="u1") as s:
+    resumed = await s.resume(query="resume the billing migration")
+    system_prompt, history = resumed.system, resumed.messages
+    await s.append({"role": "user", "content": text}, {"role": "assistant", "content": reply})
+    blob = await s.offload(build_log, summary="pytest run 812")
+    await s.note(blob["pointer"])
+```
+
+`agent.tools(user_id=..., session_id=...)` gives a model six loom verbs — `loom_remember`, `loom_recall`, `loom_ask`, `loom_offload`, `loom_fetch`, `loom_note` — as `definitions("openai" | "anthropic" | "generic")` and one `await execute(name, arguments)` that returns the string the model reads. The schemas are the same as the TypeScript SDK's.
+
+## Retries and logging
+
+The retry policy is one frozen dataclass, set on the Agent and overridable per call with a `RetryPolicy` or a dict of its fields; every field is validated and named when wrong. Defaults: 3 attempts; 0.1 s backoff doubling to 5 s with ±25 % jitter; 408 and 5xx retried for registry-idempotent ops (any other op only on a 408 or a 503 `AUTH_UNAVAILABLE`, which the server answers before running it); connection errors retried; a read timeout retried only when the registry marks the op idempotent (the server dedups its `Idempotency-Key`); a `Retry-After` on a retried status honoured up to 60 s. A 429 is paced, not retried.
+
+```python
+from loom import Agent, RetryPolicy
+
+agent = Agent(
+    "acme",
+    "support",
+    "bot",
+    retry=RetryPolicy(max_attempts=5, total_backoff_budget_s=30),
+    consumer="support-bot",
+)  # the label every ledger row carries
+await agent.call("memory.get", memory_key="k", retry={"max_attempts": 1})  # this call: no retries
+await agent.call("memory.set_from_messages", messages=msgs, retry={"retry_timeouts": "always"})
+```
+
+The SDK logs through the stdlib logger `loom` (a `NullHandler` by default; your logging config routes it): one line per completed call at INFO (`/v1/memory.get 200 12 ms attempts=2 rid=…`), retries and rate-limit waits at WARNING, the final failure at ERROR, the request headers at DEBUG. `LOOM_LOG_LEVEL` (any stdlib level name — `debug`, `info`, `warning`, `error`, `critical` — or `off`) sets the logger's level when your application has not; a value it cannot read is a warning, not an import error. Credential headers are redacted to their scheme and last four characters, and a filter on the logger rewrites any bearer token that reaches a record anyway.
+
+## Examples
+
+[`examples/agent_memory.py`](./examples/agent_memory.py) — probe → remember ×3 → recall → ask with citations → outcome → typed errors, with its actual run in [`examples/README.md`](./examples/README.md). The TypeScript SDK ships the same example.
+
+## License
+
+Apache-2.0. See [LICENSE](https://github.com/ClickHouse/loom/blob/main/LICENSE).

clickhouse_loom-1.1.0/examples/README.md

@@ -0,0 +1,38 @@
+# Examples
+
+Runnable, self-contained scripts for `clickhouse-loom`; each was executed against a live Loom before it landed here and the output below is the actual run. Every script reads `LOOM_BASE_URL`, `LOOM_API_KEY` and `LOOM_ORG` from the environment and registers a throwaway namespace. The TypeScript SDK ships the twin of `agent_memory.py` (and a session-resume example) under `sdk/typescript/examples/`.
+
+## agent_memory.py
+
+An agent that remembers what a user said, recalls it by meaning, answers with citations (or abstains), and tells loom which memories it used.
+
+```bash
+LOOM_BASE_URL=https://loom.example LOOM_API_KEY=… LOOM_ORG=acme python agent_memory.py
+```
+
+`Agent(org, namespace, agent)` stamps the identity tuple on every call; `user_id` is the per-call scope.
+
+1. `Agent.probe()` — the deployment serves `memory.set/search/ask/outcome`, and whether it has ops this SDK version does not know.
+2. `namespace.register` — the throwaway namespace; a refusal because it already exists is ignored.
+3. `memory.set` ×3 — three facts from two conversations; dedup, conflict detection and validity are the server's job.
+4. `memory.search` — semantic search with similarity per hit.
+5. `Agent.call("memory.ask", …)` — a grounded answer that cites `[memory_key]`, or `abstain=True` when the memories do not say.
+6. `memory.outcome_by_key` — the feedback loop: cited memories are marked `used`.
+7. `loom.ops.OPS` names every op; a missing key reads as `found=False`; an unknown op is a `NotFound`.
+8. `memory.delete` ×3 — in a `finally`, so the three memories are gone even when a step fails. The namespace stays registered: dropping it takes an admin.
+
+A run against an isolated Loom server on ClickHouse Cloud, gpt-4o-mini as the synthesis model. The server build, the similarities (they depend on the embedder) and the answer text (written by the model) differ from run to run; the rest of the output does not:
+
+```text
+server 2688e2476: ok=True, ops the SDK does not know: 0
+  recall 0.51  [seat_pref] "The user prefers an aisle seat on flights over three hours." (#seat_pref)
+  recall 0.23  [meal_pref] "The user asked for a vegetarian meal on their last two bookings." (#meal_pref)
+  recall 0.21  [airline_status] "The user holds gold status with Lufthansa (as of 2026-08)." (#airline_status)
+ask → abstain=False cited=['meal_pref', 'seat_pref', 'airline_status']
+     Request an aisle seat, since the user prefers an aisle seat on flights over three hours and a flight to Tokyo well exceeds that [seat_pref]. For the meal, request a vegetarian meal, matching what the user asked for on their last two bookings [meal_pref].
+
+Also note the user holds gold status with Lufthansa (as of 2026-08), which may help with seat selection [airline_status].
+memory.search is idempotent: True; role viewer
+memory.get of a missing key → found=False
+unknown op → NotFound (RESOURCE_NOT_FOUND)
+```