agent-cabinet 0.1.0__tar.gz

agent_cabinet-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,27 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v3
+      - run: uv venv --python ${{ matrix.python-version }} .venv
+      - run: uv pip install -e ".[cli,mcp]" pytest --python .venv/bin/python
+      - run: .venv/bin/python -m pytest -q

agent_cabinet-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,98 @@
+name: Release
+
+# Publishes agent-cabinet to PyPI via Trusted Publishing (OIDC) -- no stored API
+# token; PyPI authenticates the run itself once a pending publisher is registered
+# for this repo + workflow + environment. See the "Publishing" section of
+# CONTRIBUTING or the PyPI project's Trusted Publishers settings.
+#
+# Run this workflow by hand (workflow_dispatch) to rehearse a build+smoke-test
+# without publishing, or to push to TestPyPI first -- TestPyPI is a separate
+# index with its own trusted-publisher config (same repo/workflow, a "testpypi"
+# environment).
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      target:
+        description: "Where to publish (only used for workflow_dispatch)"
+        type: choice
+        options: [none, testpypi]
+        default: none
+
+permissions:
+  contents: read
+
+concurrency:
+  group: release-${{ github.ref }}
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v3
+      - run: uv build --out-dir dist
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  smoke:
+    needs: build
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: astral-sh/setup-uv@v3
+      # What PyPI itself runs on upload. A README that fails to render is
+      # rejected there, which would strand the release -- the tag and GitHub
+      # release already exist, and a version cannot be re-uploaded once taken.
+      - run: uvx twine check --strict dist/*
+      - name: Install the built wheel and smoke-test the CLI
+        run: |
+          uv venv
+          uv pip install --find-links dist "agent-cabinet[cli,mcp]"
+          .venv/bin/agent-cabinet --help > /dev/null
+          .venv/bin/python -c "import agent_cabinet; print(agent_cabinet.__version__)"
+
+  publish:
+    if: github.event_name == 'release'
+    needs: smoke
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          skip-existing: true
+
+  publish-testpypi:
+    if: github.event_name == 'workflow_dispatch' && inputs.target == 'testpypi'
+    needs: smoke
+    runs-on: ubuntu-latest
+    environment:
+      name: testpypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          skip-existing: true

agent_cabinet-0.1.0/.gitignore

@@ -0,0 +1,9 @@
+__pycache__/
+*.pyc
+.pytest_cache/
+.ruff_cache/
+.venv/
+*.egg-info/
+dist/
+build/
+.cabinet/

agent_cabinet-0.1.0/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 [yyyy] [name of copyright owner]
+
+   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.

agent_cabinet-0.1.0/PKG-INFO

@@ -0,0 +1,187 @@
+Metadata-Version: 2.5
+Name: agent-cabinet
+Version: 0.1.0
+Summary: Give your agent a filing cabinet.
+License: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: jsonschema>=4.20
+Requires-Dist: pyyaml>=6.0
+Provides-Extra: cli
+Requires-Dist: rich>=13.0; extra == 'cli'
+Requires-Dist: typer>=0.12; extra == 'cli'
+Provides-Extra: mcp
+Requires-Dist: mcp>=2.0.0; extra == 'mcp'
+Description-Content-Type: text/markdown
+
+# agent-cabinet
+
+<p>
+  <a href="https://github.com/Intelligible/agent-cabinet/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/Intelligible/agent-cabinet/actions/workflows/ci.yml/badge.svg"></a>
+  <a href="https://pypi.org/project/agent-cabinet/"><img alt="PyPI" src="https://img.shields.io/pypi/v/agent-cabinet.svg"></a>
+  <a href="https://pypi.org/project/agent-cabinet/"><img alt="Python" src="https://img.shields.io/pypi/pyversions/agent-cabinet.svg"></a>
+  <a href="./LICENSE"><img alt="License" src="https://img.shields.io/badge/license-Apache--2.0-blue.svg"></a>
+</p>
+
+**Give your agent a filing cabinet.**
+
+An agent's memory shouldn't be a black box. `agent-cabinet` stores what an
+agent files away as plain Markdown files with a YAML frontmatter block —
+readable, `grep`-able, git-diffable, editable by hand — and makes them
+searchable by meaning, not just exact words.
+
+Every entry is valid [OpenReasoningComponents](https://github.com/Intelligible/openreasoningcomponents)
+(ORC) by default, with no ceremony required to get there: the cabinet fills
+in the mechanical parts (a namespaced id, a default type, a scope) so a bare
+note and a fully-evidenced, machine-verified claim are the same file format,
+just with more filled in.
+
+## 60 seconds
+
+```bash
+pip install agent-cabinet[cli]
+agent-cabinet init
+agent-cabinet remember "The user prefers dark mode." --kind preference --basis stated
+agent-cabinet recall "theme preference"
+```
+
+Or from Python:
+
+```python
+from agent_cabinet import Cabinet
+
+cabinet = Cabinet("./.cabinet", namespace="acme-project")
+entry_id = cabinet.remember(
+    "User said the DB is Postgres, not MySQL.",
+    basis="stated",  # honest and cheap: where this came from, not a confidence score
+)
+cabinet.recall("database")[0].body
+# 'User said the DB is Postgres, not MySQL.'
+```
+
+Serve it over MCP:
+
+```bash
+pip install agent-cabinet[mcp]
+agent-cabinet mcp
+```
+
+That prints `agent-cabinet MCP server ready at http://localhost:7879/mcp`.
+Point your agent at it (exact steps for each are just below), and it now has
+somewhere to file things away that you can read, too.
+
+## Connecting Clients
+
+<details>
+<summary><strong>Claude Code</strong></summary>
+
+```bash
+claude mcp add --transport http agent-cabinet http://localhost:7879/mcp
+claude mcp list
+```
+
+</details>
+
+<details>
+<summary><strong>Cursor</strong></summary>
+
+Add a project file at `.cursor/mcp.json`:
+
+```json
+{
+  "mcpServers": {
+    "agent-cabinet": {
+      "url": "http://localhost:7879/mcp"
+    }
+  }
+}
+```
+
+</details>
+
+<details>
+<summary><strong>Codex CLI</strong></summary>
+
+```bash
+codex mcp add agent-cabinet --url http://localhost:7879/mcp
+```
+
+</details>
+
+## A note can become a verified fact
+
+`remember()` writes a plain note. `file()` writes an already-verified ORC
+component — typically from a pipeline, not a person. Both land in the same
+file format, so a note can be promoted in place later, same id, once
+something actually checks it.
+
+<details>
+<summary>See a note get promoted, one field at a time</summary>
+
+```yaml
+# remember("The DB is Postgres, not MySQL.")
+---
+id: acme-project/the_db_is_postgres_not_mysql
+type: domain_knowledge
+scope: { source: acme-project }
+---
+The DB is Postgres, not MySQL.
+```
+
+```yaml
+# remember(..., basis="stated", links=["db-migration-plan"])
+---
+id: acme-project/the_db_is_postgres_not_mysql
+type: domain_knowledge
+scope: { source: acme-project }
+basis: stated
+links: [db-migration-plan]
+---
+The DB is Postgres, not MySQL.
+```
+
+```yaml
+# file(component, overwrite=True) -- promoted later, same id, by
+# something that actually verified it
+---
+id: acme-project/the_db_is_postgres_not_mysql
+type: domain_knowledge
+scope: { source: warehouse-connection-check }
+evidence: { confirmed_by: "SELECT version() -> PostgreSQL 16.2" }
+provenance: { derivation: check_db_dialect, derivation_version: a1b2c3 }
+---
+The DB is Postgres 16.2, confirmed by direct connection.
+```
+
+</details>
+
+<details>
+<summary><strong>How search works</strong></summary>
+
+`recall()` is a rebuild-every-call BM25 pass over the cabinet — the right
+default for the dozens-to-low-hundreds of entries a typical cabinet holds.
+No index file, no server, nothing that can drift out of sync with the
+Markdown files, which stay the sole source of truth.
+
+A persisted, incremental index — dense/semantic retrieval alongside the
+lexical half — is a real upgrade once a cabinet grows into the thousands
+of entries. It isn't built yet; when it lands, it'll be a disposable cache
+derived from these same files, never a second copy of them.
+
+</details>
+
+<details>
+<summary><strong>What this doesn't do</strong></summary>
+
+- **No multi-user access control.** One writer, one directory — a person,
+  or a small team sharing a git repo. Grants, SSO, and per-entry sharing
+  are an enterprise concern for a separate product to layer on top.
+- **No confidence scores.** `basis` (`stated` / `inferred` / `observed` /
+  `assumed`) asks for something an agent actually knows — where a belief
+  came from — not a calibrated probability it would have to guess at.
+
+</details>
+
+## License
+
+Apache-2.0.