PyStreamMCP 3.3.0__tar.gz → 3.3.2__tar.gz

pystreammcp-3.3.2/LICENSE

@@ -0,0 +1,202 @@
+                                 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 2026 Georgi Mullassery
+
+   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.
+

pystreammcp-3.3.2/PKG-INFO

@@ -0,0 +1,266 @@
+Metadata-Version: 2.4
+Name: PyStreamMCP
+Version: 3.3.2
+Summary: Intelligent MCP orchestration hub - Intent understanding, capability matching, tool ranking with cohesive foundation
+Author-email: Georgi Mammen Mullassery <mullassery@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: Repository, https://github.com/Mullassery/PyStreamMCP
+Project-URL: Issues, https://github.com/Mullassery/PyStreamMCP/issues
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic>=2.0
+Requires-Dist: python-frontmatter>=1.0.0
+Requires-Dist: click>=8.0
+Requires-Dist: rich>=13.0
+Requires-Dist: httpx>=0.24.0
+Requires-Dist: toml>=0.10; python_version < "3.11"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
+Provides-Extra: api
+Requires-Dist: fastapi>=0.104.0; extra == "api"
+Requires-Dist: uvicorn[standard]>=0.24.0; extra == "api"
+Requires-Dist: pydantic-settings>=2.0; extra == "api"
+Requires-Dist: flask>=2.3.0; extra == "api"
+Provides-Extra: mcp
+Requires-Dist: mcp>=0.1.0; extra == "mcp"
+Provides-Extra: langchain
+Requires-Dist: langchain>=0.1.0; extra == "langchain"
+Provides-Extra: llamaindex
+Requires-Dist: llama-index>=0.9.0; extra == "llamaindex"
+Provides-Extra: semantic-kernel
+Requires-Dist: semantic-kernel>=0.4.0; extra == "semantic-kernel"
+Provides-Extra: crewai
+Requires-Dist: crewai>=0.1.0; extra == "crewai"
+Provides-Extra: pydantic-ai
+Requires-Dist: pydantic-ai>=0.1.0; extra == "pydantic-ai"
+Provides-Extra: haystack
+Requires-Dist: haystack-ai>=2.0.0; extra == "haystack"
+Provides-Extra: temporal
+Requires-Dist: temporalio>=1.0.0; extra == "temporal"
+Provides-Extra: airflow
+Requires-Dist: apache-airflow>=2.7.0; extra == "airflow"
+Provides-Extra: all-integrations
+Requires-Dist: langchain>=0.1.0; extra == "all-integrations"
+Requires-Dist: llama-index>=0.9.0; extra == "all-integrations"
+Requires-Dist: semantic-kernel>=0.4.0; extra == "all-integrations"
+Requires-Dist: crewai>=0.1.0; extra == "all-integrations"
+Requires-Dist: pydantic-ai>=0.1.0; extra == "all-integrations"
+Requires-Dist: haystack-ai>=2.0.0; extra == "all-integrations"
+Requires-Dist: temporalio>=1.0.0; extra == "all-integrations"
+Requires-Dist: apache-airflow>=2.7.0; extra == "all-integrations"
+Dynamic: license-file
+
+# PyStreamMCP
+
+[![PyPI](https://img.shields.io/pypi/v/pystreammcp)](https://pypi.org/project/pystreammcp/)
+[![CI](https://github.com/Mullassery/PyStreamMCP/actions/workflows/ci.yml/badge.svg)](https://github.com/Mullassery/PyStreamMCP/actions/workflows/ci.yml)
+[![Python 3.9+](https://img.shields.io/badge/Python-3.9%2B-blue)](https://www.python.org)
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](./LICENSE)
+
+Context and token optimization for AI agents — query planning, source discovery, and MCP orchestration.
+
+## What it is
+
+PyStreamMCP is an AI-agent intelligence layer: query planning, context discovery, and
+token-cost optimization, exposed both as a Python SDK and as an MCP (Model Context
+Protocol) tool server. It also includes a small event-driven orchestration/federation
+layer for coordinating multiple MCP endpoints. The published package is **pure Python** —
+`pip install` works with no Rust toolchain or compiler.
+
+## Features / Highlights
+
+- **Agent query planning** — `pystreammcp.Agent` with selectable optimization strategies
+  (`token_efficient`, `balanced`, `quality_first`) and token accounting.
+- **Source discovery** — `SourceRegistry` ranks registered data sources by real
+  word-overlap relevance (Jaccard) to a query; backs REST `/discover`, the
+  `pystreammcp_discover` MCP tool, and `LangchainAdapter.discover()`.
+- **MCP tool server** — `PyStreamMCPHandler` wires the MCP tool-call surface directly to a
+  live `Orchestrator`/`EventRouter`; MCP tool args are validated with Pydantic and the
+  advertised schema is generated from the same models.
+- **MCP orchestration & federation** — `Orchestrator` probes each configured endpoint's
+  real `tools/list` MCP method, with lexical tool-relevance ranking and capability
+  matching.
+- **Webhook event server** — `pystreammcp.server.create_flask_app()` exposes an
+  HMAC-SHA256-signed event endpoint; unsigned or invalid events are rejected, and the
+  endpoint fails closed (`503`) if no secret is configured.
+- **Framework adapters** — LangChain, LlamaIndex, CrewAI, Semantic Kernel, PydanticAI,
+  and Haystack under `pystreammcp.integrations`.
+- **CLI** — `pystreammcp` with `query` / `server` / `version` / `dashboard`.
+- **OKF integration** — an Open Knowledge Format catalog/discovery/query-planner feature
+  (see [`OKF_INTEGRATION.md`](OKF_INTEGRATION.md)).
+
+## Who it's for / Use cases
+
+- **Giving an AI agent a query-planning layer over multiple data sources**, exposed as
+  real MCP tools rather than hand-rolled per-agent glue code.
+- **Coordinating multiple MCP endpoints** through the event-driven
+  orchestration/federation layer instead of wiring each one separately.
+- **Tracking token-cost optimization** across agent queries.
+- **Adding MCP support to an existing agent framework** through the shipped adapters.
+
+## What it is not
+
+- **The Rust backend is not shipped.** `core/` and `python/src/lib.rs` are an in-progress
+  Rust workspace intended as a future performance backend; the wheel built from
+  `pyproject.toml` is pure Python. The workspace compiles and its tests pass, but it is
+  tracked separately and not part of the published package.
+- **Some orchestration capabilities are not fully implemented.** Cross-project federated
+  query *execution* and cross-database joins currently report
+  `"status": "not_implemented"` with an explanation, rather than fabricated result rows.
+- **Source discovery is a word-overlap heuristic, not semantic search.**
+  `SourceRegistry` uses Jaccard token overlap; wrap it with your own similarity scoring if
+  you need embeddings.
+- **Optional concurrency/framework packages have Python constraints.** The core SDK
+  (`Agent`, `SourceRegistry`, `Orchestrator`) supports Python 3.9+, but the `mcp` and
+  `semantic-kernel` extras require Python 3.10+ (their upstream packages don't publish
+  3.9-compatible releases). CI tests 3.10, 3.11, and 3.12 only.
+- **Known dependency CVEs.** `pip-audit` (run 2026-09-20) found 7 known CVEs in
+  transitive dependencies (`werkzeug` via `flask`, `nltk` via `llama-index`). See
+  [`ROADMAP_HONEST.md`](ROADMAP_HONEST.md) §4.
+- **The HTTP servers have no auth layer of their own.** They bind to `127.0.0.1`
+  (localhost-only) by default; pass `host="0.0.0.0"` explicitly only inside a network
+  boundary you control. The event endpoint requires HMAC-SHA256 signatures. See
+  [SECURITY.md](SECURITY.md).
+
+## Project status
+
+**Beta.** Current version **3.3.1** (`Development Status :: 4 - Beta`). The pure-Python
+package is the shipped artifact and is under active hardening; the Rust workspace compiles
+and passes its tests but is not shipped. The most recent pass fixed the Rust build,
+Python `ruff` findings, and a stale integration test — see
+[`ROADMAP_HONEST.md`](ROADMAP_HONEST.md) for the unhedged status.
+
+## Installation
+
+```bash
+pip install PyStreamMCP
+```
+
+Optional extras — install only what you need:
+
+```bash
+pip install "PyStreamMCP[api]"              # FastAPI + Flask HTTP servers
+pip install "PyStreamMCP[mcp]"              # MCP protocol client library
+pip install "PyStreamMCP[langchain]"        # LangChain adapter
+pip install "PyStreamMCP[llamaindex]"       # LlamaIndex adapter
+pip install "PyStreamMCP[semantic-kernel]"  # Semantic Kernel adapter
+pip install "PyStreamMCP[all-integrations]" # every framework adapter
+```
+
+Requires Python 3.9+ for the core SDK; the `mcp` and `semantic-kernel` extras require
+Python 3.10+.
+
+## Quick start
+
+```python
+from pystreammcp import Agent
+
+agent = Agent(
+    agent_id="recommendation_engine",
+    name="Product Recommendation Engine",
+    optimization_strategy="token_efficient",  # or "balanced" / "quality_first"
+    max_tokens=1000,
+)
+
+result = agent.query("What are the top 10 customers by lifetime value?")
+
+print(f"Baseline tokens:  {result.baseline_tokens}")
+print(f"Optimized tokens: {result.optimized_tokens}")
+print(f"Reduction:        {result.cost_reduction_percent:.1f}%")
+```
+
+Token counts are estimated from the actual query text (a ~4-characters-per-token
+heuristic) and the reduction is computed from the selected strategy — not a fixed number.
+See [`examples/basic_usage.py`](examples/basic_usage.py) for a full walkthrough.
+
+## Usage
+
+**Data source discovery:**
+
+```python
+from pystreammcp import SourceRegistry
+
+registry = SourceRegistry()
+registry.register(
+    "orders_db",
+    description="customer order history and revenue by quarter",
+    type="database",
+    tags=["orders", "revenue"],
+)
+
+results = registry.discover("customer revenue by quarter")
+# [{"name": "orders_db", "type": "database", "relevance": 0.4444, "matched_terms": [...]}]
+```
+
+**MCP orchestration & federation** (`pystreammcp.toml`):
+
+```toml
+[federation]
+endpoints = [
+    "http://localhost:8765/mcp",
+    "http://localhost:8766/mcp",
+]
+```
+
+```python
+from pystreammcp import Orchestrator
+
+orch = Orchestrator()  # reads ./pystreammcp.toml
+result = orch.discover_mcp_projects()
+```
+
+**Webhook event server (HMAC-SHA256):**
+
+```bash
+export PYSTREAMMCP_WEBHOOK_SECRET="a long random shared secret"
+```
+
+Senders compute `HMAC-SHA256(secret, raw_request_body)` and send it as
+`X-PyStreamMCP-Signature: sha256=<hex digest>`. Requests with a missing or invalid
+signature are rejected with `401`; with no secret configured, the endpoint rejects every
+request with `503`.
+
+**Testing:**
+
+```bash
+pip install -e ".[dev,api,mcp,langchain,llamaindex,semantic-kernel]"
+pytest tests/ -v
+```
+
+## Documentation
+
+- [`ROADMAP_HONEST.md`](ROADMAP_HONEST.md) — full, unhedged status: what's tested, what's fabricated/broken, technical debt, what's explicitly not built
+- [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) — how the shipped package is structured, with a diagram
+- [`OKF_INTEGRATION.md`](OKF_INTEGRATION.md) — the OKF catalog/discovery/query-planner feature
+- [`CHANGELOG.md`](CHANGELOG.md) — release history
+- [`examples/`](examples/) — runnable examples, including framework integrations and the MCP orchestrator
+
+## Contributing
+
+Contributions are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) and
+[CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md). Report security issues per
+[SECURITY.md](SECURITY.md).
+
+## Related projects
+
+- [PyStreamXL](https://github.com/Mullassery/PyStreamXL) — stream large Excel workbooks with constant memory
+- [PyStreamPDF](https://github.com/Mullassery/PyStreamPDF) — token-efficient PDF extraction for RAG
+- [PyStreamMCP](https://github.com/Mullassery/PyStreamMCP) — context and token optimization for AI agents
+- [PyStreamAI](https://github.com/Mullassery/PyStreamAI) — ML deployment toolkit (canary/A-B, cost tracking, ONNX)
+- [PyTokenCalc](https://github.com/Mullassery/PyTokenCalc) — LLM token counting and cost estimation
+- [Browse all projects](https://github.com/Mullassery?tab=repositories)
+
+## License
+
+This project is licensed under the [Apache License 2.0](LICENSE).

pystreammcp-3.3.2/README.md

@@ -0,0 +1,203 @@
+# PyStreamMCP
+
+[![PyPI](https://img.shields.io/pypi/v/pystreammcp)](https://pypi.org/project/pystreammcp/)
+[![CI](https://github.com/Mullassery/PyStreamMCP/actions/workflows/ci.yml/badge.svg)](https://github.com/Mullassery/PyStreamMCP/actions/workflows/ci.yml)
+[![Python 3.9+](https://img.shields.io/badge/Python-3.9%2B-blue)](https://www.python.org)
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](./LICENSE)
+
+Context and token optimization for AI agents — query planning, source discovery, and MCP orchestration.
+
+## What it is
+
+PyStreamMCP is an AI-agent intelligence layer: query planning, context discovery, and
+token-cost optimization, exposed both as a Python SDK and as an MCP (Model Context
+Protocol) tool server. It also includes a small event-driven orchestration/federation
+layer for coordinating multiple MCP endpoints. The published package is **pure Python** —
+`pip install` works with no Rust toolchain or compiler.
+
+## Features / Highlights
+
+- **Agent query planning** — `pystreammcp.Agent` with selectable optimization strategies
+  (`token_efficient`, `balanced`, `quality_first`) and token accounting.
+- **Source discovery** — `SourceRegistry` ranks registered data sources by real
+  word-overlap relevance (Jaccard) to a query; backs REST `/discover`, the
+  `pystreammcp_discover` MCP tool, and `LangchainAdapter.discover()`.
+- **MCP tool server** — `PyStreamMCPHandler` wires the MCP tool-call surface directly to a
+  live `Orchestrator`/`EventRouter`; MCP tool args are validated with Pydantic and the
+  advertised schema is generated from the same models.
+- **MCP orchestration & federation** — `Orchestrator` probes each configured endpoint's
+  real `tools/list` MCP method, with lexical tool-relevance ranking and capability
+  matching.
+- **Webhook event server** — `pystreammcp.server.create_flask_app()` exposes an
+  HMAC-SHA256-signed event endpoint; unsigned or invalid events are rejected, and the
+  endpoint fails closed (`503`) if no secret is configured.
+- **Framework adapters** — LangChain, LlamaIndex, CrewAI, Semantic Kernel, PydanticAI,
+  and Haystack under `pystreammcp.integrations`.
+- **CLI** — `pystreammcp` with `query` / `server` / `version` / `dashboard`.
+- **OKF integration** — an Open Knowledge Format catalog/discovery/query-planner feature
+  (see [`OKF_INTEGRATION.md`](OKF_INTEGRATION.md)).
+
+## Who it's for / Use cases
+
+- **Giving an AI agent a query-planning layer over multiple data sources**, exposed as
+  real MCP tools rather than hand-rolled per-agent glue code.
+- **Coordinating multiple MCP endpoints** through the event-driven
+  orchestration/federation layer instead of wiring each one separately.
+- **Tracking token-cost optimization** across agent queries.
+- **Adding MCP support to an existing agent framework** through the shipped adapters.
+
+## What it is not
+
+- **The Rust backend is not shipped.** `core/` and `python/src/lib.rs` are an in-progress
+  Rust workspace intended as a future performance backend; the wheel built from
+  `pyproject.toml` is pure Python. The workspace compiles and its tests pass, but it is
+  tracked separately and not part of the published package.
+- **Some orchestration capabilities are not fully implemented.** Cross-project federated
+  query *execution* and cross-database joins currently report
+  `"status": "not_implemented"` with an explanation, rather than fabricated result rows.
+- **Source discovery is a word-overlap heuristic, not semantic search.**
+  `SourceRegistry` uses Jaccard token overlap; wrap it with your own similarity scoring if
+  you need embeddings.
+- **Optional concurrency/framework packages have Python constraints.** The core SDK
+  (`Agent`, `SourceRegistry`, `Orchestrator`) supports Python 3.9+, but the `mcp` and
+  `semantic-kernel` extras require Python 3.10+ (their upstream packages don't publish
+  3.9-compatible releases). CI tests 3.10, 3.11, and 3.12 only.
+- **Known dependency CVEs.** `pip-audit` (run 2026-09-20) found 7 known CVEs in
+  transitive dependencies (`werkzeug` via `flask`, `nltk` via `llama-index`). See
+  [`ROADMAP_HONEST.md`](ROADMAP_HONEST.md) §4.
+- **The HTTP servers have no auth layer of their own.** They bind to `127.0.0.1`
+  (localhost-only) by default; pass `host="0.0.0.0"` explicitly only inside a network
+  boundary you control. The event endpoint requires HMAC-SHA256 signatures. See
+  [SECURITY.md](SECURITY.md).
+
+## Project status
+
+**Beta.** Current version **3.3.1** (`Development Status :: 4 - Beta`). The pure-Python
+package is the shipped artifact and is under active hardening; the Rust workspace compiles
+and passes its tests but is not shipped. The most recent pass fixed the Rust build,
+Python `ruff` findings, and a stale integration test — see
+[`ROADMAP_HONEST.md`](ROADMAP_HONEST.md) for the unhedged status.
+
+## Installation
+
+```bash
+pip install PyStreamMCP
+```
+
+Optional extras — install only what you need:
+
+```bash
+pip install "PyStreamMCP[api]"              # FastAPI + Flask HTTP servers
+pip install "PyStreamMCP[mcp]"              # MCP protocol client library
+pip install "PyStreamMCP[langchain]"        # LangChain adapter
+pip install "PyStreamMCP[llamaindex]"       # LlamaIndex adapter
+pip install "PyStreamMCP[semantic-kernel]"  # Semantic Kernel adapter
+pip install "PyStreamMCP[all-integrations]" # every framework adapter
+```
+
+Requires Python 3.9+ for the core SDK; the `mcp` and `semantic-kernel` extras require
+Python 3.10+.
+
+## Quick start
+
+```python
+from pystreammcp import Agent
+
+agent = Agent(
+    agent_id="recommendation_engine",
+    name="Product Recommendation Engine",
+    optimization_strategy="token_efficient",  # or "balanced" / "quality_first"
+    max_tokens=1000,
+)
+
+result = agent.query("What are the top 10 customers by lifetime value?")
+
+print(f"Baseline tokens:  {result.baseline_tokens}")
+print(f"Optimized tokens: {result.optimized_tokens}")
+print(f"Reduction:        {result.cost_reduction_percent:.1f}%")
+```
+
+Token counts are estimated from the actual query text (a ~4-characters-per-token
+heuristic) and the reduction is computed from the selected strategy — not a fixed number.
+See [`examples/basic_usage.py`](examples/basic_usage.py) for a full walkthrough.
+
+## Usage
+
+**Data source discovery:**
+
+```python
+from pystreammcp import SourceRegistry
+
+registry = SourceRegistry()
+registry.register(
+    "orders_db",
+    description="customer order history and revenue by quarter",
+    type="database",
+    tags=["orders", "revenue"],
+)
+
+results = registry.discover("customer revenue by quarter")
+# [{"name": "orders_db", "type": "database", "relevance": 0.4444, "matched_terms": [...]}]
+```
+
+**MCP orchestration & federation** (`pystreammcp.toml`):
+
+```toml
+[federation]
+endpoints = [
+    "http://localhost:8765/mcp",
+    "http://localhost:8766/mcp",
+]
+```
+
+```python
+from pystreammcp import Orchestrator
+
+orch = Orchestrator()  # reads ./pystreammcp.toml
+result = orch.discover_mcp_projects()
+```
+
+**Webhook event server (HMAC-SHA256):**
+
+```bash
+export PYSTREAMMCP_WEBHOOK_SECRET="a long random shared secret"
+```
+
+Senders compute `HMAC-SHA256(secret, raw_request_body)` and send it as
+`X-PyStreamMCP-Signature: sha256=<hex digest>`. Requests with a missing or invalid
+signature are rejected with `401`; with no secret configured, the endpoint rejects every
+request with `503`.
+
+**Testing:**
+
+```bash
+pip install -e ".[dev,api,mcp,langchain,llamaindex,semantic-kernel]"
+pytest tests/ -v
+```
+
+## Documentation
+
+- [`ROADMAP_HONEST.md`](ROADMAP_HONEST.md) — full, unhedged status: what's tested, what's fabricated/broken, technical debt, what's explicitly not built
+- [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) — how the shipped package is structured, with a diagram
+- [`OKF_INTEGRATION.md`](OKF_INTEGRATION.md) — the OKF catalog/discovery/query-planner feature
+- [`CHANGELOG.md`](CHANGELOG.md) — release history
+- [`examples/`](examples/) — runnable examples, including framework integrations and the MCP orchestrator
+
+## Contributing
+
+Contributions are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) and
+[CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md). Report security issues per
+[SECURITY.md](SECURITY.md).
+
+## Related projects
+
+- [PyStreamXL](https://github.com/Mullassery/PyStreamXL) — stream large Excel workbooks with constant memory
+- [PyStreamPDF](https://github.com/Mullassery/PyStreamPDF) — token-efficient PDF extraction for RAG
+- [PyStreamMCP](https://github.com/Mullassery/PyStreamMCP) — context and token optimization for AI agents
+- [PyStreamAI](https://github.com/Mullassery/PyStreamAI) — ML deployment toolkit (canary/A-B, cost tracking, ONNX)
+- [PyTokenCalc](https://github.com/Mullassery/PyTokenCalc) — LLM token counting and cost estimation
+- [Browse all projects](https://github.com/Mullassery?tab=repositories)
+
+## License
+
+This project is licensed under the [Apache License 2.0](LICENSE).