token-sentinel 1.0.0__tar.gz

token_sentinel-1.0.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 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 2026 TokenSentinel contributors
+
+   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.

token_sentinel-1.0.0/PKG-INFO

@@ -0,0 +1,253 @@
+Metadata-Version: 2.4
+Name: token-sentinel
+Version: 1.0.0
+Summary: Predictive token-waste detection for AI agents
+Project-URL: Homepage, https://tokensentinel.dev
+Project-URL: Documentation, https://docs.tokensentinel.dev
+Project-URL: Issues, https://github.com/tokensentinel/tokensentinel-sdk-python/issues
+Project-URL: Repository, https://github.com/tokensentinel/tokensentinel-sdk-python
+Project-URL: Changelog, https://github.com/tokensentinel/tokensentinel-sdk-python/blob/main/CHANGELOG.md
+Author-email: TokenSentinel contributors <shakyasmreta@gmail.com>
+License: Apache-2.0
+License-File: LICENSE
+Keywords: agents,anthropic,cost,finops,llm,observability,openai,tokens
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Monitoring
+Requires-Python: >=3.10
+Provides-Extra: all
+Requires-Dist: anthropic>=0.39.0; extra == 'all'
+Requires-Dist: boto3>=1.35.0; extra == 'all'
+Requires-Dist: cohere>=5.0; extra == 'all'
+Requires-Dist: deepgram-sdk>=3.0; extra == 'all'
+Requires-Dist: elevenlabs>=1.0; extra == 'all'
+Requires-Dist: google-genai>=1.0.0; extra == 'all'
+Requires-Dist: imagehash>=4.3; extra == 'all'
+Requires-Dist: langchain-core>=0.3; extra == 'all'
+Requires-Dist: mutagen>=1.47; extra == 'all'
+Requires-Dist: numpy>=1.26.0; extra == 'all'
+Requires-Dist: openai>=1.50.0; extra == 'all'
+Requires-Dist: opentelemetry-api>=1.27; extra == 'all'
+Requires-Dist: opentelemetry-sdk>=1.27; extra == 'all'
+Requires-Dist: opentelemetry-semantic-conventions>=0.48b0; extra == 'all'
+Requires-Dist: pillow>=10; extra == 'all'
+Requires-Dist: replicate>=0.40; extra == 'all'
+Requires-Dist: sentence-transformers>=2.7.0; extra == 'all'
+Requires-Dist: voyageai>=0.2; extra == 'all'
+Provides-Extra: anthropic
+Requires-Dist: anthropic>=0.39.0; extra == 'anthropic'
+Provides-Extra: audio-metadata
+Requires-Dist: mutagen>=1.47; extra == 'audio-metadata'
+Provides-Extra: bedrock
+Requires-Dist: boto3>=1.35.0; extra == 'bedrock'
+Provides-Extra: cohere
+Requires-Dist: cohere>=5.0; extra == 'cohere'
+Provides-Extra: deepgram
+Requires-Dist: deepgram-sdk>=3.0; extra == 'deepgram'
+Provides-Extra: dev
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest-cov>=7.0; extra == 'dev'
+Requires-Dist: pytest-mock>=3.15; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.5; extra == 'dev'
+Provides-Extra: elevenlabs
+Requires-Dist: elevenlabs>=1.0; extra == 'elevenlabs'
+Provides-Extra: embeddings
+Requires-Dist: numpy>=1.26.0; extra == 'embeddings'
+Requires-Dist: sentence-transformers>=2.7.0; extra == 'embeddings'
+Provides-Extra: gemini
+Requires-Dist: google-genai>=1.0.0; extra == 'gemini'
+Provides-Extra: langchain
+Requires-Dist: langchain-core>=0.3; extra == 'langchain'
+Provides-Extra: openai
+Requires-Dist: openai>=1.50.0; extra == 'openai'
+Provides-Extra: otel
+Requires-Dist: opentelemetry-api>=1.27; extra == 'otel'
+Requires-Dist: opentelemetry-sdk>=1.27; extra == 'otel'
+Requires-Dist: opentelemetry-semantic-conventions>=0.48b0; extra == 'otel'
+Provides-Extra: replicate
+Requires-Dist: replicate>=0.40; extra == 'replicate'
+Provides-Extra: vision-perceptual
+Requires-Dist: imagehash>=4.3; extra == 'vision-perceptual'
+Requires-Dist: pillow>=10; extra == 'vision-perceptual'
+Provides-Extra: voyage
+Requires-Dist: voyageai>=0.2; extra == 'voyage'
+Description-Content-Type: text/markdown
+
+# token-sentinel
+
+Predictive token-waste detection for AI agents.
+
+A Python SDK that catches token waste *mid-run* — before the meter spins — and gives your app a callback to log, alert, or hard-stop the agent. Apache-2.0 licensed, zero-dependency core. Pair the SDK with the optional TokenSentinel Cloud for hosted dashboards, budget enforcement, drift detection, and judge ratification on Pro.
+
+Existing observability tools (Langfuse, LangSmith, Helicone, Datadog LLM) tell you what your bill was. TokenSentinel tells you which agent is leaking *right now*.
+
+## What it catches
+
+Fifteen deterministic rules, all in-process, sub-millisecond per rule:
+
+| Leak / Waste | Signal |
+|---|---|
+| **Tool-loop** | Same tool, ≥3 cosine-similar calls in a window |
+| **Context bloat** | Prompt-tokens-per-turn slope rising past threshold |
+| **Embedding waste** | Same embedding lookup repeated within session |
+| **Zombie agent** | No user-facing output for N min, calls still firing |
+| **Model misroute** | Classification-shaped prompt sent to a frontier model |
+| **Retry storm** | Same call retried >N times without parameter change |
+| **Tool-definition bloat** | A single request ships ≥30 tool defs or ≥30KB of tool JSON (the MCP problem) |
+| **Retrieval thrash** | Retrieval tool called repeatedly with overlapping queries (the RAG problem) |
+| **Vision re-upload** | Same image (SHA-256 or perceptual hash) uploaded repeatedly across turns |
+| **Vision detail misroute** | High-detail vision flag on low-detail-suitable images (e.g. icons, low-res) |
+| **Vision concentration** | Visual tokens heavily concentrated in a single/few outlier sessions |
+| **Audio channel doubling** | Stereo/multichannel audio transcription when mono-channel would suffice |
+| **Voice switching loop** | Rapid shifting of ElevenLabs voice IDs on identical text payloads |
+| **Rerank thrash** | Cohere rerank API requests repeated for identical search lists |
+| **Repair loop** | Conversational loop with repeated user corrections and similar agent regenerations |
+
+**Composite signals (Pro tier, cloud-side)**
+
+| Composite | Fires when |
+|---|---|
+| **lost_agent** | `tool_loop` + `context_bloat` + `model_misroute` all hit on the same session inside a 30s window |
+| **runaway_retrieval** | `retrieval_thrash` + `embedding_waste` co-fire while the per-turn token slope is still climbing |
+| **zombie_loop** | `zombie` + `retry_storm` co-fire on a session with no user-facing output |
+
+## Supported providers
+
+Native wrappers — `pip install token-sentinel[<provider>]`:
+
+| Provider | SDK | Streaming | Async |
+|---|---|---|---|
+| Anthropic | `anthropic` | yes | yes |
+| OpenAI | `openai` | yes¹ | yes |
+| Google Gemini | `google-genai` | yes | yes |
+| AWS Bedrock | `boto3` | yes | sync only |
+
+¹ OpenAI streaming instrumentation shipped in stable release.
+
+Transparent through the OpenAI wrapper (just set `base_url`):
+
+DeepSeek · Together AI · Fireworks · Groq · OpenRouter · Anyscale · Mistral La Plateforme · Perplexity · vLLM · Ollama · text-generation-inference · LM Studio
+
+Google Vertex AI is reached via the same Gemini wrapper by passing `vertexai=True` to `genai.Client(...)`.
+
+See [docs/providers.md](docs/providers.md) for the full matrix and per-provider snippets.
+
+## Quick start
+
+```bash
+pip install token-sentinel[anthropic]
+```
+
+```python
+from token_sentinel import Sentinel
+import anthropic
+
+sentinel = Sentinel(project="my-agent", mode="log")  # log | alert | block
+
+@sentinel.on_leak
+def handle(event):
+    print(f"LEAK [{event.type}] confidence={event.confidence:.2f} burn=${event.estimated_burn:.4f}")
+
+client = sentinel.wrap(anthropic.Anthropic())
+# use the client normally — Sentinel watches in-process
+client.messages.create(
+    model="claude-sonnet-4-6",
+    max_tokens=100,
+    messages=[{"role": "user", "content": "Hello"}],
+)
+```
+
+Switch providers by installing the right extra and changing one line:
+
+```python
+# DeepSeek (or any OpenAI-compatible endpoint)
+import openai
+client = sentinel.wrap(openai.OpenAI(base_url="https://api.deepseek.com"))
+
+# Google Gemini
+from google import genai
+client = sentinel.wrap(genai.Client())
+
+# AWS Bedrock
+import boto3
+client = sentinel.wrap(boto3.client("bedrock-runtime"))
+```
+
+Per-provider deep dives — install, wrap, leak, stream, async, production:
+
+- [Anthropic quickstart](docs/quickstart-anthropic.md)
+- [OpenAI quickstart](docs/quickstart-openai.md) (covers DeepSeek, Together, Groq, vLLM, Ollama, …)
+- [Gemini quickstart](docs/quickstart-gemini.md) (covers Vertex AI)
+- [Bedrock quickstart](docs/quickstart-bedrock.md)
+
+## Modes
+
+| Mode | Behavior |
+|---|---|
+| `log` | Emit events to your handler. Default. Safe for production from day one. |
+| `alert` | Same as `log` plus optional cloud-sink delivery for dashboards and webhooks. |
+| `block` | Raise `LeakDetected` to halt the agent at the next boundary. Opt-in. |
+
+## Works with MCP, RAG, and orchestration frameworks
+
+TokenSentinel instruments at the LLM-client layer, so it transparently catches traffic from MCP hosts, RAG pipelines, and orchestration frameworks (LangChain, LangGraph, CrewAI, AutoGen, Pydantic AI). See [docs/integration-patterns.md](docs/integration-patterns.md).
+
+## Cloud (optional)
+
+The hosted TokenSentinel Cloud is closed-source, opt-in, configured via the SDK's `cloud_endpoint=` and `api_key=` constructor args. Without those, nothing leaves the process. The cloud provides retention, a hosted dashboard, the **Intervention Pack** (budget caps + velocity ceilings + kill-switch), and on Pro: LLM-as-judge ratification, drift detection, trace consolidation, RBAC, audit logs, multi-environment routing, the cost estimator, and OAuth login.
+
+Tier comparison and pricing are detailed on the official website: see [tokensentinel.dev](https://tokensentinel.dev) for the customer-facing tier story.
+
+## Migrate from Helicone / Langfuse / LangSmith
+
+The `tokensentinel-migrate` companion package replays your existing trace history through the rules and backfills events into your TokenSentinel cloud project. See the [tokensentinel-migrate package on PyPI](https://pypi.org/project/tokensentinel-migrate/).
+
+```bash
+pip install tokensentinel-migrate
+python -m tokensentinel_migrate helicone --helicone-api-key sk-... --tokensentinel-endpoint https://... --tokensentinel-api-key tsk_... --project my-agent --since 2026-04-09 --dry-run
+```
+
+> **Self-hosted note.** vLLM / Ollama / TGI all expose OpenAI-compatible endpoints, so TokenSentinel works against them out of the box. Leak signals are real, but the dollar burn estimate assumes priced API usage — for self-hosted, treat the burn estimate as a quality signal, not a billing signal.
+
+## Status
+
+**Stable Release** — 15 deterministic rules, 9 native providers (Anthropic, OpenAI, Gemini, Bedrock, Voyage, Cohere, Replicate, Deepgram, ElevenLabs), streaming + async, and full integration with the optional TokenSentinel Cloud policy engine.
+
+**Tests**: 912 SDK tests passing. Codebase is clean of ruff, mypy, and typecheck warnings.
+
+The public API surface (`Sentinel`, `wrap`, `on_leak`, `record_call`, `LeakEvent`, `CallRecord`, `LeakDetected`, plus the  enforcement exceptions `BudgetExceeded`, `VelocityExceeded`, `KillSwitchActive`) is stable and follows semver — pin to a minor version (e.g., `token-sentinel>=0.10,<0.11`) and upgrade deliberately.
+
+## Architecture
+
+- **SDK (this package)** — Python wrapper around all major LLM clients. Apache-2.0 licensed.
+- **Optional cloud dashboard** — closed-source, hosted at `api.tokensentinel.dev`. Provides retention, dashboards, the Intervention Pack policy plane, the LLM-as-judge ratification pipeline, drift / stability scoring, RBAC + audit, and multi-environment routing. The SDK works perfectly without it; nothing phones home unless you explicitly configure `cloud_endpoint` and `api_key`.
+
+rule detection runs entirely in-process. The composite rules and judge ratification run cloud-side on top of the same `LeakEvent` stream. Cloud is opt-in for retention, dashboards, team features, and the chargeback attribution coming in V2.
+
+## Docs
+
+User-facing docs (published with the OSS SDK):
+
+- [User Guide](docs/user/) — installation, quickstart, modes, leak rules, providers, integrations, API reference
+- [Architecture](docs/architecture.md) — how the wrapper, tracer, and rules engine fit together
+- [Leak taxonomy](docs/waste-taxonomy.md) — the rules in detail with thresholds and false-positive hazards
+- [Providers](docs/providers.md) — full matrix of supported providers
+- [Integration patterns](docs/integration-patterns.md) — MCP, RAG, LangChain, LangGraph, CrewAI, AutoGen, Pydantic AI
+- [Changelog](CHANGELOG.md)
+
+## Contact & Support
+
+For support, feedback, or inquiries, please contact shakyasmreta@gmail.com or visit our official website at [tokensentinel.dev](https://tokensentinel.dev).
+
+## License
+
+Apache-2.0 — see [LICENSE](LICENSE). The patent grant in Apache-2.0 is the right OSS contract for an SDK that runs inline against enterprise customers' production AI calls.

token_sentinel-1.0.0/README.md

@@ -0,0 +1,169 @@
+# token-sentinel
+
+Predictive token-waste detection for AI agents.
+
+A Python SDK that catches token waste *mid-run* — before the meter spins — and gives your app a callback to log, alert, or hard-stop the agent. Apache-2.0 licensed, zero-dependency core. Pair the SDK with the optional TokenSentinel Cloud for hosted dashboards, budget enforcement, drift detection, and judge ratification on Pro.
+
+Existing observability tools (Langfuse, LangSmith, Helicone, Datadog LLM) tell you what your bill was. TokenSentinel tells you which agent is leaking *right now*.
+
+## What it catches
+
+Fifteen deterministic rules, all in-process, sub-millisecond per rule:
+
+| Leak / Waste | Signal |
+|---|---|
+| **Tool-loop** | Same tool, ≥3 cosine-similar calls in a window |
+| **Context bloat** | Prompt-tokens-per-turn slope rising past threshold |
+| **Embedding waste** | Same embedding lookup repeated within session |
+| **Zombie agent** | No user-facing output for N min, calls still firing |
+| **Model misroute** | Classification-shaped prompt sent to a frontier model |
+| **Retry storm** | Same call retried >N times without parameter change |
+| **Tool-definition bloat** | A single request ships ≥30 tool defs or ≥30KB of tool JSON (the MCP problem) |
+| **Retrieval thrash** | Retrieval tool called repeatedly with overlapping queries (the RAG problem) |
+| **Vision re-upload** | Same image (SHA-256 or perceptual hash) uploaded repeatedly across turns |
+| **Vision detail misroute** | High-detail vision flag on low-detail-suitable images (e.g. icons, low-res) |
+| **Vision concentration** | Visual tokens heavily concentrated in a single/few outlier sessions |
+| **Audio channel doubling** | Stereo/multichannel audio transcription when mono-channel would suffice |
+| **Voice switching loop** | Rapid shifting of ElevenLabs voice IDs on identical text payloads |
+| **Rerank thrash** | Cohere rerank API requests repeated for identical search lists |
+| **Repair loop** | Conversational loop with repeated user corrections and similar agent regenerations |
+
+**Composite signals (Pro tier, cloud-side)**
+
+| Composite | Fires when |
+|---|---|
+| **lost_agent** | `tool_loop` + `context_bloat` + `model_misroute` all hit on the same session inside a 30s window |
+| **runaway_retrieval** | `retrieval_thrash` + `embedding_waste` co-fire while the per-turn token slope is still climbing |
+| **zombie_loop** | `zombie` + `retry_storm` co-fire on a session with no user-facing output |
+
+## Supported providers
+
+Native wrappers — `pip install token-sentinel[<provider>]`:
+
+| Provider | SDK | Streaming | Async |
+|---|---|---|---|
+| Anthropic | `anthropic` | yes | yes |
+| OpenAI | `openai` | yes¹ | yes |
+| Google Gemini | `google-genai` | yes | yes |
+| AWS Bedrock | `boto3` | yes | sync only |
+
+¹ OpenAI streaming instrumentation shipped in stable release.
+
+Transparent through the OpenAI wrapper (just set `base_url`):
+
+DeepSeek · Together AI · Fireworks · Groq · OpenRouter · Anyscale · Mistral La Plateforme · Perplexity · vLLM · Ollama · text-generation-inference · LM Studio
+
+Google Vertex AI is reached via the same Gemini wrapper by passing `vertexai=True` to `genai.Client(...)`.
+
+See [docs/providers.md](docs/providers.md) for the full matrix and per-provider snippets.
+
+## Quick start
+
+```bash
+pip install token-sentinel[anthropic]
+```
+
+```python
+from token_sentinel import Sentinel
+import anthropic
+
+sentinel = Sentinel(project="my-agent", mode="log")  # log | alert | block
+
+@sentinel.on_leak
+def handle(event):
+    print(f"LEAK [{event.type}] confidence={event.confidence:.2f} burn=${event.estimated_burn:.4f}")
+
+client = sentinel.wrap(anthropic.Anthropic())
+# use the client normally — Sentinel watches in-process
+client.messages.create(
+    model="claude-sonnet-4-6",
+    max_tokens=100,
+    messages=[{"role": "user", "content": "Hello"}],
+)
+```
+
+Switch providers by installing the right extra and changing one line:
+
+```python
+# DeepSeek (or any OpenAI-compatible endpoint)
+import openai
+client = sentinel.wrap(openai.OpenAI(base_url="https://api.deepseek.com"))
+
+# Google Gemini
+from google import genai
+client = sentinel.wrap(genai.Client())
+
+# AWS Bedrock
+import boto3
+client = sentinel.wrap(boto3.client("bedrock-runtime"))
+```
+
+Per-provider deep dives — install, wrap, leak, stream, async, production:
+
+- [Anthropic quickstart](docs/quickstart-anthropic.md)
+- [OpenAI quickstart](docs/quickstart-openai.md) (covers DeepSeek, Together, Groq, vLLM, Ollama, …)
+- [Gemini quickstart](docs/quickstart-gemini.md) (covers Vertex AI)
+- [Bedrock quickstart](docs/quickstart-bedrock.md)
+
+## Modes
+
+| Mode | Behavior |
+|---|---|
+| `log` | Emit events to your handler. Default. Safe for production from day one. |
+| `alert` | Same as `log` plus optional cloud-sink delivery for dashboards and webhooks. |
+| `block` | Raise `LeakDetected` to halt the agent at the next boundary. Opt-in. |
+
+## Works with MCP, RAG, and orchestration frameworks
+
+TokenSentinel instruments at the LLM-client layer, so it transparently catches traffic from MCP hosts, RAG pipelines, and orchestration frameworks (LangChain, LangGraph, CrewAI, AutoGen, Pydantic AI). See [docs/integration-patterns.md](docs/integration-patterns.md).
+
+## Cloud (optional)
+
+The hosted TokenSentinel Cloud is closed-source, opt-in, configured via the SDK's `cloud_endpoint=` and `api_key=` constructor args. Without those, nothing leaves the process. The cloud provides retention, a hosted dashboard, the **Intervention Pack** (budget caps + velocity ceilings + kill-switch), and on Pro: LLM-as-judge ratification, drift detection, trace consolidation, RBAC, audit logs, multi-environment routing, the cost estimator, and OAuth login.
+
+Tier comparison and pricing are detailed on the official website: see [tokensentinel.dev](https://tokensentinel.dev) for the customer-facing tier story.
+
+## Migrate from Helicone / Langfuse / LangSmith
+
+The `tokensentinel-migrate` companion package replays your existing trace history through the rules and backfills events into your TokenSentinel cloud project. See the [tokensentinel-migrate package on PyPI](https://pypi.org/project/tokensentinel-migrate/).
+
+```bash
+pip install tokensentinel-migrate
+python -m tokensentinel_migrate helicone --helicone-api-key sk-... --tokensentinel-endpoint https://... --tokensentinel-api-key tsk_... --project my-agent --since 2026-04-09 --dry-run
+```
+
+> **Self-hosted note.** vLLM / Ollama / TGI all expose OpenAI-compatible endpoints, so TokenSentinel works against them out of the box. Leak signals are real, but the dollar burn estimate assumes priced API usage — for self-hosted, treat the burn estimate as a quality signal, not a billing signal.
+
+## Status
+
+**Stable Release** — 15 deterministic rules, 9 native providers (Anthropic, OpenAI, Gemini, Bedrock, Voyage, Cohere, Replicate, Deepgram, ElevenLabs), streaming + async, and full integration with the optional TokenSentinel Cloud policy engine.
+
+**Tests**: 912 SDK tests passing. Codebase is clean of ruff, mypy, and typecheck warnings.
+
+The public API surface (`Sentinel`, `wrap`, `on_leak`, `record_call`, `LeakEvent`, `CallRecord`, `LeakDetected`, plus the  enforcement exceptions `BudgetExceeded`, `VelocityExceeded`, `KillSwitchActive`) is stable and follows semver — pin to a minor version (e.g., `token-sentinel>=0.10,<0.11`) and upgrade deliberately.
+
+## Architecture
+
+- **SDK (this package)** — Python wrapper around all major LLM clients. Apache-2.0 licensed.
+- **Optional cloud dashboard** — closed-source, hosted at `api.tokensentinel.dev`. Provides retention, dashboards, the Intervention Pack policy plane, the LLM-as-judge ratification pipeline, drift / stability scoring, RBAC + audit, and multi-environment routing. The SDK works perfectly without it; nothing phones home unless you explicitly configure `cloud_endpoint` and `api_key`.
+
+rule detection runs entirely in-process. The composite rules and judge ratification run cloud-side on top of the same `LeakEvent` stream. Cloud is opt-in for retention, dashboards, team features, and the chargeback attribution coming in V2.
+
+## Docs
+
+User-facing docs (published with the OSS SDK):
+
+- [User Guide](docs/user/) — installation, quickstart, modes, leak rules, providers, integrations, API reference
+- [Architecture](docs/architecture.md) — how the wrapper, tracer, and rules engine fit together
+- [Leak taxonomy](docs/waste-taxonomy.md) — the rules in detail with thresholds and false-positive hazards
+- [Providers](docs/providers.md) — full matrix of supported providers
+- [Integration patterns](docs/integration-patterns.md) — MCP, RAG, LangChain, LangGraph, CrewAI, AutoGen, Pydantic AI
+- [Changelog](CHANGELOG.md)
+
+## Contact & Support
+
+For support, feedback, or inquiries, please contact shakyasmreta@gmail.com or visit our official website at [tokensentinel.dev](https://tokensentinel.dev).
+
+## License
+
+Apache-2.0 — see [LICENSE](LICENSE). The patent grant in Apache-2.0 is the right OSS contract for an SDK that runs inline against enterprise customers' production AI calls.