maivn-tools 0.1.0__tar.gz

maivn_tools-0.1.0/.github/workflows/publish-pypi.yml

@@ -0,0 +1,42 @@
+name: Publish PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch:
+
+concurrency:
+  group: maivn-tools-pypi-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+  id-token: write
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - uses: astral-sh/setup-uv@v6
+
+      - name: Validate release version
+        # release_guard imports tomllib (3.11+ stdlib). This repo's .python-version
+        # pins 3.10, which uv honors even with --no-project, so pin 3.12 here.
+        run: uv run --with packaging --no-project --python 3.12 python scripts/release_guard.py
+
+      - name: Build distributions
+        run: uv build
+
+      - name: Validate distributions
+        run: uvx twine check dist/*
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

maivn_tools-0.1.0/.gitignore

@@ -0,0 +1,22 @@
+.venv/
+.pytest_cache/
+.ruff_cache/
+__pycache__/
+*.egg-info/
+build/
+dist/
+htmlcov/
+.coverage
+uv.lock
+
+# Internal planning documents. Keep these out of public repository/docs pushes.
+private-docs/
+docs/OFFICIAL_TOOL_SET_OUTLINE.md
+docs/OFFICIAL_TOOL_SET_IMPLEMENTATION_TRACKER.md
+
+# Local-only agent adapters that point agents at private planning documents.
+AGENTS.md
+CLAUDE.md
+CLAUDE.local.md
+.windsurf/
+.cursor/

maivn_tools-0.1.0/.python-version

@@ -0,0 +1 @@
+3.10

maivn_tools-0.1.0/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2026-06-04
+
+Initial release (experimental). First publish to PyPI.
+
+### Added
+
+- Agent-ready ToolSet connector suite built on the mAIvn `@toolset` / `@toolify`
+  class-based tool pattern, registrable via `agent.add_toolset(...)`.

maivn_tools-0.1.0/LICENSE

@@ -0,0 +1,176 @@
+Apache License
+Version 2.0, January 2004
+https://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

maivn_tools-0.1.0/NOTICE

@@ -0,0 +1,4 @@
+mAIvn Tools
+Copyright 2026 mAIvn
+
+This product includes software developed by mAIvn.

maivn_tools-0.1.0/PKG-INFO

@@ -0,0 +1,76 @@
+Metadata-Version: 2.4
+Name: maivn-tools
+Version: 0.1.0
+Summary: Optional tool integrations for the mAIvn Python SDK
+Project-URL: Homepage, https://maivn.io
+Project-URL: Repository, https://github.com/mAIvn-developer/maivn-tools
+Project-URL: Issues, https://github.com/mAIvn-developer/maivn-tools/issues
+Project-URL: Changelog, https://github.com/mAIvn-developer/maivn-tools/blob/master/CHANGELOG.md
+Author-email: Chad Heathcote <developer@maivn.io>
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: agents,ai,maivn,sdk,tools
+Classifier: Development Status :: 3 - Alpha
+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 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: maivn<0.5.0,>=0.4.0
+Requires-Dist: pydantic>=2.0
+Provides-Extra: all
+Requires-Dist: psycopg[binary]>=3.1; extra == 'all'
+Requires-Dist: pypdf>=4.0; extra == 'all'
+Requires-Dist: python-docx>=1.0; extra == 'all'
+Provides-Extra: docx
+Requires-Dist: python-docx>=1.0; extra == 'docx'
+Provides-Extra: html
+Provides-Extra: pdf
+Requires-Dist: pypdf>=4.0; extra == 'pdf'
+Provides-Extra: postgres
+Requires-Dist: psycopg[binary]>=3.1; extra == 'postgres'
+Description-Content-Type: text/markdown
+
+# mAIvn Tools
+
+Official optional connector layer for the [mAIvn Python SDK](https://github.com/mAIvn-developer/maivn).
+
+> [!warning]
+> **Experimental — use with care.** `maivn-tools` is in early development
+> (alpha). Connectors and toolsets are exercised against a mock transport in
+> CI, but **most have not yet been validated end-to-end against live
+> third-party provider APIs**. Request shapes, behavior, and the public surface
+> may change between releases. Test against your own provider accounts before
+> relying on any connector in production, and please
+> [report issues](https://github.com/mAIvn-developer/maivn-tools/issues).
+
+`maivn-tools` is a standalone PyPI package that depends on `maivn`. Installing it
+pulls the SDK as well:
+
+```bash
+pip install maivn-tools
+```
+
+The package is not exposed as a `maivn[tools]` extra. That would create the same
+circular release coupling we removed for `maivn[studio]` in 0.3.0; instead,
+`maivn-tools` pins a compatible SDK version range directly.
+
+## Development
+
+```powershell
+uv sync
+uv run pytest
+uv run ruff check .
+uv run pyright
+```
+
+See [`docs/`](docs) for usage guides and [`docs/index.md`](docs/index.md) for the
+documentation index.

maivn_tools-0.1.0/README.md

@@ -0,0 +1,35 @@
+# mAIvn Tools
+
+Official optional connector layer for the [mAIvn Python SDK](https://github.com/mAIvn-developer/maivn).
+
+> [!warning]
+> **Experimental — use with care.** `maivn-tools` is in early development
+> (alpha). Connectors and toolsets are exercised against a mock transport in
+> CI, but **most have not yet been validated end-to-end against live
+> third-party provider APIs**. Request shapes, behavior, and the public surface
+> may change between releases. Test against your own provider accounts before
+> relying on any connector in production, and please
+> [report issues](https://github.com/mAIvn-developer/maivn-tools/issues).
+
+`maivn-tools` is a standalone PyPI package that depends on `maivn`. Installing it
+pulls the SDK as well:
+
+```bash
+pip install maivn-tools
+```
+
+The package is not exposed as a `maivn[tools]` extra. That would create the same
+circular release coupling we removed for `maivn[studio]` in 0.3.0; instead,
+`maivn-tools` pins a compatible SDK version range directly.
+
+## Development
+
+```powershell
+uv sync
+uv run pytest
+uv run ruff check .
+uv run pyright
+```
+
+See [`docs/`](docs) for usage guides and [`docs/index.md`](docs/index.md) for the
+documentation index.

maivn_tools-0.1.0/docs/AGENT_READY_PATTERN.md

@@ -0,0 +1,169 @@
+# Agent-Ready ToolSet Pattern Spec
+
+**Reference implementation:** `src/maivn_tools/connectors/google_workspace/gmail.py` (GmailToolSet).
+**Reference demo:** `apps/maivn-demos/demos/custom_toolset_demo.py` (FleetOpsToolSet).
+
+A developer should be able to plug any ToolSet into an Agent with
+`agent.add_toolset(MyToolSet(...))` and get useful behavior from ordinary
+user prompts — no custom graph wiring, no demo-specific wrappers, no
+long system prompts.
+
+---
+
+## 1. Permissions and tags
+
+Every `@toolify` method must declare a `PermissionSet`:
+
+```python
+@toolify(permissions=PermissionSet(PermissionFlag.READ))
+def list_records(self, ...) -> ...:
+    ...
+
+@toolify(permissions=PermissionSet(PermissionFlag.WRITE))
+def create_record(self, ...) -> ...:
+    ...
+
+@toolify(permissions=PermissionSet(PermissionFlag.DELETE), destructive=True)
+def delete_record(self, ...) -> ...:
+    ...
+```
+
+Rules:
+- READ tools are filterable with `include_tags=["read"]`.
+- WRITE tools should be separate from READ tools.
+- DELETE or irreversible tools must use `destructive=True` and are
+  filterable with `exclude_tags=["destructive"]`.
+- The "read"/"write"/"destructive" tags are auto-derived from
+  `permissions`/`destructive`; do not maintain a parallel `tags=` list.
+
+## 2. Tool docstrings
+
+Each tool docstring should briefly explain:
+- **when to use** the tool ("Best first tool for triage", "Use after
+  list_records to fetch full content", etc.).
+- **what arguments mean** (especially anything non-obvious).
+- **what shape** the tool returns.
+- **what follow-up tool** should consume any returned identifiers.
+- whether **IDs are internal handles** that should not appear in final
+  answers.
+
+Keep it short. Optimize for model usability, not API-reference prose.
+
+## 3. Human-readable defaults for search/list/lookup
+
+For broad search/list tools:
+
+- Return **compact, human-readable summaries by default**.
+- Avoid dumping raw provider IDs unless needed.
+- Prefer stable display refs like `message_ref`, `record_ref`,
+  `ticket_ref`, `page_ref`, etc.
+- Add an opt-in flag `include_ids: bool = False` when downstream tools
+  need raw IDs.
+- If raw IDs are included, the docstring must say they are internal
+  handles and should not be exposed in final answers.
+
+Example pattern:
+
+```python
+@toolify(permissions=PermissionSet(PermissionFlag.READ))
+def list_records(
+    self,
+    *,
+    table_id: str,
+    max_results: int = 25,
+    include_ids: bool = False,
+) -> dict[str, Any]:
+    """Search records in a table.
+
+    Best first tool for record exploration. Returns compact summaries
+    with a stable ``record_ref`` (``record_1``, ``record_2``, ...) that
+    is safe to show in final answers. Raw provider IDs are omitted by
+    default — they are internal handles. Set ``include_ids=True`` only
+    when a follow-up tool (update_record, delete_record) needs the raw
+    ID.
+    """
+    ...
+    summaries = []
+    for index, record in enumerate(records, start=1):
+        summary = {
+            "record_ref": f"record_{index}",
+            # ...display fields like name, status, created_at, ...
+        }
+        if include_ids:
+            summary["record_id"] = record["id"]
+        summaries.append(summary)
+    return {"records": summaries, ...}
+```
+
+## 4. Bounded list/search behavior
+
+- Broad list/search tools should default to a small useful limit (10
+  or 25, not 100+).
+- Expensive metadata expansion should be capped — if summary mode
+  requires a per-record fetch, cap to a smaller limit (e.g. 10 in Gmail).
+- Raw/full output should be opt-in (e.g. `include_metadata=False` returns
+  raw provider response with all fields).
+- Preserve pagination tokens where provider APIs support them.
+
+## 5. Tolerant write-tool inputs
+
+Write tools should accept the natural output of corresponding read/list
+tools when practical. For example, if `list_records()` returns records
+with `record_id` (in `include_ids=True` mode) or `record_ref` paired with
+raw IDs in another field, then `update_record()` should tolerate:
+
+- the raw ID string
+- the returned record dict (look up `record_id` inside it)
+- a list of returned records (select the first valid candidate when safe
+  and obvious)
+
+Do not make write tools dangerously permissive. Only add tolerance where
+it removes obvious agent friction and preserves safe behavior. See
+`FleetOpsToolSet._select_vehicle_id` for the reference pattern.
+
+## 6. Structured model fields
+
+Any Pydantic model intended as a model/final tool must use brief
+`Field(description=...)` values for all fields. Descriptions should be
+short and operational, not verbose.
+
+## 7. Keep provider toolsets generic
+
+Do not bake demo-specific behavior into provider toolsets. Use the SDK
+`ToolOverride` pattern for app-specific behavior:
+
+- direct tools: `agent.add_tool(..., override=ToolOverride(...))`
+- toolsets: `agent.add_toolset(toolset, overrides={"method_name": ToolOverride(...)})`
+- MCP servers: `MCPServer(..., tool_overrides={"raw_tool_name": ToolOverride(...)})`
+
+Use overrides for: app-specific descriptions, default args,
+always-execute/final-tool behavior, app-specific dependencies, renamed
+public tool names.
+
+## 8. Demo prompts
+
+Demo prompts should be plain user workflows. They should not instruct
+exact tool order unless the workflow truly requires it. If the demo only
+works with detailed tool choreography, fix the toolset instead.
+
+## 9. Tests
+
+For each updated toolset, add or update tests for:
+
+- Default search/list summaries (verify `_ref` is present and raw IDs
+  are absent).
+- `include_ids=True` returns raw IDs (verify the opt-in works).
+- Permission/tag filtering on the toolset class (`include_tags=["read"]`
+  drops write/destructive tools).
+- Tolerant input behavior for write tools where added.
+
+## Constraints
+
+- Do not remove useful existing capabilities.
+- Do not hide IDs when a provider operation cannot be performed without
+  them; make IDs opt-in or return them only in fields intended for
+  follow-up tool calls.
+- Final answers should be useful to humans and should not be littered
+  with raw provider IDs.
+- The core success criterion: an Agent with a ToolSet should work from
+  ordinary user requests.

maivn_tools-0.1.0/docs/api-policy.md

@@ -0,0 +1,87 @@
+# Public API policy
+
+`maivn-tools` follows semantic versioning. This page is the contract
+between the package and its users about what is stable, what is not, and
+how breaking changes are introduced.
+
+## Versioning
+
+Releases use **MAJOR.MINOR.PATCH** semantics:
+
+- **MAJOR** — incompatible public-API changes.
+- **MINOR** — new public surface and new connectors that do not break
+  existing imports.
+- **PATCH** — bug fixes and internal changes.
+
+## Stable surface
+
+Anything reachable from `maivn_tools.*` is part of the stable surface.
+Specifically:
+
+- `maivn_tools.core` — protocols, metadata, permissions, dry-run, registration.
+- `maivn_tools.auth` — auth strategies, secret resolvers, OAuth flow layer.
+- `maivn_tools.runtime` — HTTP client, retries, rate limits, pagination,
+  errors.
+- `maivn_tools.events` — audit events and webhook helpers.
+- `maivn_tools.files` — MIME, attachments, extractors, transfers.
+- `maivn_tools.testing` — mock transport and helpers.
+- `maivn_tools.connectors.*` — every shipped connector and its tools.
+
+Stable means:
+
+- Module paths do not move between minor releases.
+- Constructor argument names and types follow semver.
+- Tool function names and keyword arguments follow semver.
+- Public dataclass fields can be added but not removed or renamed without a
+  major bump.
+- Exceptions raised by public functions stay within the documented
+  hierarchy.
+
+## Internal surface
+
+Anything matching the following patterns is internal and may change at any
+time:
+
+- Identifiers prefixed with `_` (e.g. `_SharedCursor`).
+- Anything under `maivn_tools._internal` (currently unused, reserved).
+- Module-level constants prefixed with `_`.
+
+## Deprecation policy
+
+When a public symbol is replaced:
+
+1. The new symbol ships alongside the old in a minor release.
+2. The old symbol emits a `DeprecationWarning` from the same release.
+3. The old symbol is removed no sooner than the next major release.
+
+Deprecations are recorded in `CHANGELOG.md` under the affected version.
+
+## Optional dependencies
+
+Connectors that need third-party drivers (e.g. `psycopg`, `pypdf`,
+`python-docx`) declare them through pip extras:
+
+```bash
+pip install maivn-tools[postgres,pdf,docx]
+```
+
+A new extra is added in a minor release. Removing an extra requires a
+major bump.
+
+## Python support
+
+The package supports the three most recent CPython minor versions. The
+classifier list in `pyproject.toml` is authoritative.
+
+## Connector additions and removals
+
+- Adding a new connector is always a minor change.
+- Removing a connector is a major change. Connectors that are being
+  superseded are deprecated for at least one major version before removal.
+
+## Reporting incompatibilities
+
+If a release breaks an import that this policy promises is stable, file
+an issue at https://github.com/mAIvn-developer/maivn-tools/issues. The
+fix is to restore the symbol in a patch release and re-deprecate it if
+necessary.