mcbp-core 0.1.6__tar.gz

mcbp_core-0.1.6/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 MCBP.PLUS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mcbp_core-0.1.6/PKG-INFO

@@ -0,0 +1,81 @@
+Metadata-Version: 2.4
+Name: mcbp-core
+Version: 0.1.6
+Summary: Shared async HTTP client + typed errors for BAS MCBP_AI (used by backend and mcp-server)
+Author: MCBP.PLUS
+License-Expression: MIT
+Project-URL: Homepage, https://mcbp.plus
+Project-URL: Repository, https://github.com/kzavrazhnyi/mcbp-mcp-server
+Keywords: bas,1c,erp,mcbp,httpx
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.27
+Provides-Extra: dev
+Requires-Dist: pytest>=8.3; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.24; extra == "dev"
+Requires-Dist: respx>=0.21; extra == "dev"
+Requires-Dist: ruff>=0.7; extra == "dev"
+Dynamic: license-file
+
+# mcbp-core
+
+Async HTTP client and shared tool registry for the **BAS / 1C `MCBP_AI`** service (`/ai/v1`).
+
+This is the engine shared by two front-ends: the [`mcbp`](https://pypi.org/project/mcbp/)
+MCP server and a FastAPI web chat. It holds everything that knows about BAS — routes, filters,
+response shapes, typed errors — so those front-ends hold none of it.
+
+> **Requires a server-side component.** `mcbp-core` talks to the `MCBP_AI` HTTP service, a BSL
+> module installed into a BAS/1C configuration through Конфігуратор. That module is licensed
+> separately and is not part of this package. Without it there is nothing to connect to.
+
+The MCBP+ configuration and the `MCBP_AI` service module are proprietary works of
+**[MCBP.PLUS](https://mcbp.plus)** and are distributed separately. This MIT licence covers the
+Python package only.
+
+## What it gives you
+
+- **`MCBPClient`** — one pooled `httpx.AsyncClient` over the BAS publication: HTTP Basic auth,
+  retries on `503`, an in-memory metadata cache, and an offline mock mode for tests.
+- **Typed errors** — the `{"error": {"code", "message"}}` envelope BAS returns is mapped to
+  exception classes (`ParameterError`, `NotFoundError`, `KeyMismatchError`, `PlusRequiredError`, …),
+  so callers branch on type instead of re-parsing text.
+- **A tool registry** — 13 `ToolSpec`s (JSON Schema + async executor) covering catalogs, documents,
+  registers, metadata introspection and the gated write routes. Both front-ends register from this
+  one list, so their surfaces cannot drift apart.
+
+## Usage
+
+```python
+from mcbp_core.client import ConnectionConfig, MCBPClient
+from mcbp_core.tools import tool_specs
+
+client = MCBPClient(ConnectionConfig(
+    base_url="http://host/base/hs/mcbp_ai",   # without the /ai/v1 suffix — the client adds it
+    user="ai_service", password="***", mock=False,
+))
+await client.startup()
+try:
+    rows = await client.list_catalog(type_="Номенклатура", cursor=None, limit=50, q="кабель")
+finally:
+    await client.shutdown()
+```
+
+Selecting the tools a front-end should expose:
+
+```python
+read_only = tool_specs(surface="mcp")                        # 10 specs
+everything = tool_specs(surface="mcp", include_write=True)   # 13 specs
+```
+
+Tool descriptions are Ukrainian by default; `ToolSpec.description_en` carries the English variant
+used by the MCP surface.
+
+## Requirements
+
+Python 3.11+.
+
+## License
+
+MIT — see `LICENSE`.

mcbp_core-0.1.6/README.md

@@ -0,0 +1,61 @@
+# mcbp-core
+
+Async HTTP client and shared tool registry for the **BAS / 1C `MCBP_AI`** service (`/ai/v1`).
+
+This is the engine shared by two front-ends: the [`mcbp`](https://pypi.org/project/mcbp/)
+MCP server and a FastAPI web chat. It holds everything that knows about BAS — routes, filters,
+response shapes, typed errors — so those front-ends hold none of it.
+
+> **Requires a server-side component.** `mcbp-core` talks to the `MCBP_AI` HTTP service, a BSL
+> module installed into a BAS/1C configuration through Конфігуратор. That module is licensed
+> separately and is not part of this package. Without it there is nothing to connect to.
+
+The MCBP+ configuration and the `MCBP_AI` service module are proprietary works of
+**[MCBP.PLUS](https://mcbp.plus)** and are distributed separately. This MIT licence covers the
+Python package only.
+
+## What it gives you
+
+- **`MCBPClient`** — one pooled `httpx.AsyncClient` over the BAS publication: HTTP Basic auth,
+  retries on `503`, an in-memory metadata cache, and an offline mock mode for tests.
+- **Typed errors** — the `{"error": {"code", "message"}}` envelope BAS returns is mapped to
+  exception classes (`ParameterError`, `NotFoundError`, `KeyMismatchError`, `PlusRequiredError`, …),
+  so callers branch on type instead of re-parsing text.
+- **A tool registry** — 13 `ToolSpec`s (JSON Schema + async executor) covering catalogs, documents,
+  registers, metadata introspection and the gated write routes. Both front-ends register from this
+  one list, so their surfaces cannot drift apart.
+
+## Usage
+
+```python
+from mcbp_core.client import ConnectionConfig, MCBPClient
+from mcbp_core.tools import tool_specs
+
+client = MCBPClient(ConnectionConfig(
+    base_url="http://host/base/hs/mcbp_ai",   # without the /ai/v1 suffix — the client adds it
+    user="ai_service", password="***", mock=False,
+))
+await client.startup()
+try:
+    rows = await client.list_catalog(type_="Номенклатура", cursor=None, limit=50, q="кабель")
+finally:
+    await client.shutdown()
+```
+
+Selecting the tools a front-end should expose:
+
+```python
+read_only = tool_specs(surface="mcp")                        # 10 specs
+everything = tool_specs(surface="mcp", include_write=True)   # 13 specs
+```
+
+Tool descriptions are Ukrainian by default; `ToolSpec.description_en` carries the English variant
+used by the MCP surface.
+
+## Requirements
+
+Python 3.11+.
+
+## License
+
+MIT — see `LICENSE`.

mcbp_core-0.1.6/mcbp_core/__init__.py

@@ -0,0 +1,10 @@
+"""mcbp-core — shared BAS MCBP_AI HTTP client, typed errors, and tool registry.
+
+No dependency on any specific host application (backend FastAPI app, mcp-server, ...).
+Consumers build a `ConnectionConfig` from their own settings and pass it to `MCBPClient`;
+`mcbp_core.tools.tool_specs()` gives every caller the same `ToolSpec` registry: 13 tools, of
+which the 10 read-only ones are returned by default. `include_write=True` adds `write_object`,
+`save_context` and `patch_object`; `surface=` narrows the list to one front-end.
+"""
+
+__version__ = "0.1.6"