opencontextengine-client 0.1.0__tar.gz

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

@@ -0,0 +1,84 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+  workflow_dispatch:
+
+concurrency:
+  group: ci-${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: test (py${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up uv and Python
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          enable-cache: true
+
+      - name: Install locked dependencies
+        run: uv sync --extra dev --extra mcp --locked
+
+      - name: Smoke import
+        run: uv run python -c "import oce_client; from oce_client.mcp_server import create_server; print(oce_client.__version__)"
+
+      - name: Run tests
+        run: uv run pytest -q
+
+  build:
+    name: build (packaging)
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up uv and Python
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: "3.13"
+          enable-cache: true
+
+      - name: Build sdist and wheel
+        run: uv build
+
+      - name: Validate bundled skill
+        shell: bash
+        run: |
+          python - <<'PY'
+          import glob
+          import zipfile
+
+          wheel = glob.glob("dist/*.whl")
+          if len(wheel) != 1:
+              raise SystemExit(f"expected one wheel, found: {wheel}")
+          with zipfile.ZipFile(wheel[0]) as archive:
+              names = set(archive.namelist())
+          required = {
+              "oce_client/skill/SKILL.md",
+              "oce_client/skill/agents/openai.yaml",
+          }
+          missing = required - names
+          if missing:
+              raise SystemExit(f"wheel is missing bundled skill files: {sorted(missing)}")
+          PY
+
+      - name: Upload dist artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/*
+          if-no-files-found: error

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

@@ -0,0 +1,63 @@
+name: Release
+
+on:
+  push:
+    tags: ["v*.*.*"]
+
+permissions:
+  contents: read
+
+concurrency:
+  group: release-${{ github.ref }}
+  cancel-in-progress: false
+
+jobs:
+  test:
+    name: release validation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up uv and Python
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: "3.13"
+          enable-cache: true
+
+      - name: Install locked dependencies
+        run: uv sync --extra dev --extra mcp --locked
+
+      - name: Validate tag version
+        shell: bash
+        run: |
+          tag_version="${GITHUB_REF_NAME#v}"
+          project_version="$(uv run python -c 'from importlib.metadata import version; print(version("opencontextengine-client"))')"
+          if [[ "${project_version}" != "${tag_version}" ]]; then
+            echo "pyproject version ${project_version} does not match tag ${tag_version}"
+            exit 1
+          fi
+
+      - name: Run tests
+        run: uv run pytest -q
+
+  python-package:
+    name: publish Python package
+    needs: test
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up uv and Python
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: "3.13"
+          enable-cache: true
+
+      - name: Build sdist and wheel
+        run: uv build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

opencontextengine_client-0.1.0/.gitignore

@@ -0,0 +1,28 @@
+# Python-generated files
+__pycache__/
+*.py[cod]
+build/
+dist/
+wheels/
+*.egg-info/
+
+# Virtual environments
+.venv/
+
+# Test and tooling caches
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.coverage
+htmlcov/
+
+# IDE and operating-system files
+.idea/
+.vscode/
+*.swp
+.DS_Store
+
+# Local client state and secrets
+.oce-client/
+.env
+.env.*

opencontextengine_client-0.1.0/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+This project follows [Semantic Versioning](https://semver.org/).
+Entries are generated from Conventional Commits.
+
+## [Unreleased]
+
+## [0.1.0] - 2026-08-30
+
+### Added
+
+- **mcp**: add background incremental indexing
+- **mcp**: expose unified codebase retrieval tool
+- initialize oce-client
+
+### Changed
+
+- **skill**: keep interface guidance CLI-only
+- **skill**: clarify CLI agent workflow
+- **cli**: keep MCP as standalone entry point
+- **config**: unify cli and mcp settings
+- **client**: remove unsupported retrieval endpoints

opencontextengine_client-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+Copyright 2026 OpenContextEngine Contributors
+
+   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, 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.

opencontextengine_client-0.1.0/PKG-INFO

@@ -0,0 +1,162 @@
+Metadata-Version: 2.5
+Name: opencontextengine-client
+Version: 0.1.0
+Summary: Standalone workspace and blob synchronization client for OpenContextEngine
+Project-URL: Homepage, https://github.com/oce-ai/oce-client
+Project-URL: Repository, https://github.com/oce-ai/oce-client
+Project-URL: Documentation, https://github.com/oce-ai/oce-client/blob/master/README.md
+Project-URL: Issues, https://github.com/oce-ai/oce-client/issues
+Author: OpenContextEngine Contributors
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: ai,code,context,mcp,retrieval
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.11
+Requires-Dist: httpx>=0.25.0
+Requires-Dist: pathspec>=0.12.1
+Requires-Dist: watchfiles>=1.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Provides-Extra: mcp
+Requires-Dist: mcp<2,>=1.0.0; extra == 'mcp'
+Description-Content-Type: text/markdown
+
+# opencontextengine-client
+
+Standalone synchronous Python client for OpenContextEngine workspace and blob
+management. The package owns local inventory, ignore rules, upload planning,
+checkpoint state, and retrieval adapters. It does not depend on Auggie SDK.
+
+Install the distribution package with `uv add opencontextengine-client` (or
+`pip install opencontextengine-client`). The installed command remains
+`oce-client`.
+
+## Version Information
+
+Run `oce-client --version` to print the installed client version.
+
+| Item | Value |
+| --- | --- |
+| PyPI distribution | `opencontextengine-client` |
+| Python package | `oce_client` |
+| CLI | `oce-client` |
+| MCP server | `oce-client-mcp` (separate interface) |
+| Version command | `oce-client --version` |
+
+The authoritative version is declared in `pyproject.toml` and mirrored by
+`oce_client.__version__`.
+
+## Release Preparation
+
+The first release uses the current version because the repository has no
+release tag yet:
+
+```powershell
+uv run python scripts/release.py 0.1.0 --dry-run
+uv run python scripts/release.py 0.1.0
+```
+
+For later releases, use `major`, `minor`, `patch`, or an exact higher version.
+The script updates version metadata, generates the changelog, builds the
+package, creates a release commit, and creates an annotated tag locally. It
+never pushes or publishes automatically; review the result before pushing the
+branch and tag.
+
+## CLI
+
+Install the package with `uv` and configure the service endpoint and key through
+the environment:
+
+```powershell
+# These are the built-in defaults; override them only when needed.
+$env:OCE_API_URL = "http://127.0.0.1:8986"
+$env:OCE_API_KEY = "sk-opencontextengine"
+$env:OCE_WORKSPACE = (Get-Location).Path
+uv run oce-client sync
+uv run oce-client retrieve "where is request authentication implemented?"
+```
+
+If unset, `OCE_API_URL` defaults to `http://127.0.0.1:8986` and `OCE_API_KEY`
+defaults to `sk-opencontextengine`. `status` is local-only and does not require
+an API key. `observe` and `remove`
+stage explicit editor changes in SQLite; run `sync` to publish them. Add
+`--json` to `sync`, `status`, `retrieve`, `observe`, or `remove` for
+machine-readable output. CLI options are placed before the subcommand, for
+example `oce-client --root C:\src\project sync`; `--root` falls back to
+`OCE_WORKSPACE`, and `--api-url`, `--state-path`, and repeated `--ignore`
+override `OCE_API_URL`, `OCE_STATE_PATH`, and `OCE_IGNORE`.
+
+The two interfaces have different lifecycles:
+
+| Interface | Workspace selection | State selection | Index lifecycle |
+| --- | --- | --- | --- |
+| CLI | one `--root` or `OCE_WORKSPACE` | `--state-path` or `OCE_STATE_PATH` | explicit `sync`, optional `watch` |
+| MCP | repeated `--workspace`, `OCE_WORKSPACE`, or `OCE_WORKSPACES` | one `--state-path`, or per-workspace `--state-dir` | process-owned background and incremental sync |
+
+## MCP
+
+Install the optional MCP extra and expose the stdio server to an MCP host:
+
+```powershell
+uv sync --extra mcp
+uv run oce-client-mcp --workspace C:\path\to\workspace
+```
+
+The server exposes one tool, `codebase-retrieval`. Workspace indexing belongs
+to the MCP process rather than the coding agent: the server starts the initial
+index in the background, watches the filesystem, and synchronizes only changed
+paths. Unchanged files are identified by stored filesystem metadata and are not
+read or rehashed on restart.
+
+Declare each allowed workspace with a repeated `--workspace` argument. With one
+workspace, the tool's `workspace_folder` input is optional. With multiple
+workspaces it is required and must exactly match an allowed path. Other paths
+are rejected. For an environment-only setup, use `OCE_WORKSPACE` for one path
+or `OCE_WORKSPACES` with paths separated by the platform path separator. MCP
+does not fall back to the process current directory.
+
+```powershell
+oce-client-mcp `
+  --workspace C:\src\project-a `
+  --workspace C:\src\project-b `
+  --state-dir $env:LOCALAPPDATA\oce-client `
+  --initial-sync background `
+  --debounce-ms 500 `
+  --ready-timeout 3
+```
+
+`--initial-sync` accepts `background` (default), `blocking`, or `off`; `off`
+defers initialization until the first retrieval call. A tool call waits up to
+`--ready-timeout` seconds for the latest observed filesystem generation. Its
+result status is `ready`, `indexing`, or `error`; only a `ready` result contains
+retrieval context. `OCE_API_URL`, `OCE_API_KEY`, `OCE_STATE_PATH`, `OCE_STATE_DIR`, `OCE_IGNORE`,
+`OCE_DEBOUNCE_MS`, `OCE_INITIAL_SYNC`, `OCE_READY_TIMEOUT`, and
+`OCE_LOG_LEVEL` provide environment equivalents. `--state-path` and
+`OCE_STATE_PATH` are for one workspace; use `--state-dir` or `OCE_STATE_DIR`
+for multiple workspaces. Keep the API key in the environment rather than
+command arguments.
+
+The service endpoint, API key, and ignore patterns are shared through the same
+environment variables. State selection follows the interface table above. A
+Codex-ready skill with the host configuration and command guidance is included
+at `skills/oce-client/SKILL.md`.
+
+After installing a wheel, locate or install that skill with:
+
+```powershell
+uv run oce-client skill path
+uv run oce-client skill install
+```
+
+The default installation target is `$CODEX_HOME/skills/oce-client` or
+`$HOME/.codex/skills/oce-client`. Existing skill directories are preserved;
+pass `--force` only when intentionally updating one.
+
+Keep `OCE_API_KEY` in the host's environment or secret manager; do not commit it
+to an MCP configuration file.