Metadata-Version: 2.5
Name: agent-wkp
Version: 0.1.0
Summary: Workspace Knowledge Protocol — progressive disclosure knowledge index for agent frameworks
Project-URL: Homepage, https://github.com/williamcaban/wkp
Project-URL: Repository, https://github.com/williamcaban/wkp
Project-URL: Documentation, https://github.com/williamcaban/wkp/blob/main/docs/architecture.md
Project-URL: Bug Tracker, https://github.com/williamcaban/wkp/issues
Project-URL: Changelog, https://github.com/williamcaban/wkp/releases
Author-email: William Caban <william.caban@gmail.com>
License:                                  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 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, as submitted to the 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 designated in writing by the copyright owner as "Not a
              Contribution."
        
              "Contributor" shall mean Licensor and any Legal Entity on behalf of
              whom a Contribution has been received by the Licensor and included
              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 the combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted.
        
           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, You must include a
                  readable copy of the attribution notices contained within such
                  NOTICE file, as 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.
        
              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.
        
           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.
        
           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 reproducing 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 exemplary damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (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 offer only
              conditions consistent with this License.
        
           END OF TERMS AND CONDITIONS
        
           Copyright 2026 William Caban
        
           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.
License-File: LICENSE
Keywords: agent,claude-code,knowledge-graph,llm,progressive-disclosure,rag,semantic-search,sqlite-vec
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
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.12
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Text Processing :: Indexing
Classifier: Typing :: Typed
Requires-Python: >=3.12
Requires-Dist: click>=8.1.0
Requires-Dist: networkx>=3.3
Requires-Dist: numpy>=1.26.0
Requires-Dist: pyyaml>=6.0
Requires-Dist: sentence-transformers>=3.1.0
Requires-Dist: sqlite-vec>=0.1.6
Description-Content-Type: text/markdown

# WKP — Workspace Knowledge Protocol

Progressive disclosure knowledge index for AI agent workspaces. WKP turns a directory of markdown files into a searchable, tier-aware knowledge store that any agent harness can consume — without heavy infrastructure.

## The problem it solves

Agent context windows are finite. Loading everything you know into every session wastes tokens, degrades model performance, and inflates cost. But loading nothing means the agent starts cold every time.

WKP enforces a four-tier disclosure model so the agent always has the minimum useful context, and can fetch more on demand:

| Tier | Token budget | When it loads | Mechanism |
|------|-------------|--------------|-----------|
| 0 | ≤4k | Every session, guaranteed | Static file injected by SessionStart hook |
| 1 | ≤8k | Session start, topic-gated | Lightweight index assembled by hook |
| 2 | ≤16k | Mid-session, on demand | `wkp search` or `wkp context` via Bash |
| 3 | Unlimited | Explicit fetch only | Direct file read |

Tier 0 is **structurally guaranteed** — it is never retrieved, never skipped, and does not depend on any search system being available.

## How it works

1. You write markdown files with [OKF frontmatter](#okf-frontmatter) declaring `type`, `workspace`, `tokens`, and `refs`.
2. `wkp index` embeds each file (CPU-only, `all-MiniLM-L6-v2`, ~40ms/file) and stores the embeddings alongside metadata and explicit graph edges in a single SQLite file (`.wkp/index.db`).
3. `wkp search "topic"` runs hybrid retrieval: vector similarity + BM25 keyword search merged via Reciprocal Rank Fusion, filtered by tier and token budget.
4. `wkp materialize --tier 0` pre-assembles the always-on context into `.wkp/tier0.md`.
5. A git post-commit hook keeps the index current — only re-embeds files whose git blob SHA changed.

## Quickstart

```bash
pip install agent-wkp    # or: pipx install agent-wkp

cd your-workspace
wkp init           # creates .wkp/, adds to .gitignore
wkp index          # full index (downloads ~22MB model on first run)
wkp materialize --tier 0
wkp hooks --framework claude_code --post-commit

# Search from any agent or shell
wkp search "rfe creation workflow"
wkp context "evalhub adapter" --tier 2 --budget 8000
wkp traverse memory/my-file.md --depth 2
wkp analyze        # PageRank — suggests Tier 1 promotions
```

## OKF Frontmatter

WKP reads **OKF (Open Knowledge Frontmatter)** from every markdown file:

```yaml
---
title: Short descriptive title
type: reference          # project-state | knowledge | reference | feedback | skill
workspace: root          # root | eval-hub | trustworthy-ai | ...
visibility: shared       # shared | private
tokens: ~800             # rough token estimate (used for budget enforcement)
tags: [rfe, jira, pm]
refs:
  - ../other-workspace/knowledge/shared/related-file.md
updated: 2026-09-02
---
```

**Type → tier mapping** (enforced in the SQLite schema):

| OKF type | Tier |
|---|---|
| `feedback` | 1 |
| `project-state` | 1 |
| `skill` | 1 |
| `knowledge` | 2 |
| `reference` | 2 |

Files without OKF frontmatter are indexed with `type = NULL` (treated as Tier 2).

## Using with Claude Code

After `wkp hooks --framework claude_code`, the SessionStart hook injects Tier 0 context before your first message. For Tier 2 on-demand retrieval, call `wkp` from a skill:

```bash
# Inside a skill instruction or directly in Claude Code:
wkp search "nemo guardrails" --tier 2 --budget 6000
wkp context "rfe creation" --tier 2
```

No MCP tool quota is consumed. `wkp` runs as a Bash subprocess.

To wire the hook into Claude Code add to `.claude/settings.local.json`:

```json
{
  "hooks": {
    "SessionStart": [
      { "command": "bash .claude/hooks/wkp-session-start.sh" }
    ]
  }
}
```

## CLI reference

```
wkp init                          Initialise index in this workspace
wkp index [FILES]                 Index all (or specified) markdown files
  --force                         Re-embed even if git blob SHA unchanged
wkp search QUERY                  Hybrid semantic + keyword search
  --tier INT                      Max tier to include (default: 2)
  --budget INT                    Token budget (default: 8000)
  -k INT                          Max results (default: 10)
  --format [text|json|paths]
wkp context TOPIC                 Tier-aware context assembly
  --tier INT  --budget INT
wkp traverse PATH                 BFS traversal from PATH via explicit edges
  --depth INT  --budget INT
wkp materialize --tier [0|1]      Pre-assemble static context file
wkp hooks --framework claude_code Install SessionStart hook
  --post-commit                   Also install git post-commit hook
wkp analyze                       PageRank — suggest Tier 1 promotions
  --top INT                       Number of candidates (default: 10)
```

## Requirements

- Python 3.12+
- `sqlite-vec` (vector similarity in SQLite — no server required)
- `sentence-transformers` (downloads `all-MiniLM-L6-v2` on first index run, ~22MB)
- `networkx` (graph analytics — only loaded by `wkp analyze`)
- Git (for blob SHA cache invalidation)

No database server. No Docker. The entire index is a single file: `.wkp/index.db`.

## Scalability

WKP uses a `VectorBackend` protocol so the storage layer can be swapped without changing CLI or skill code:

| Scale | Backend | Switch |
|---|---|---|
| <100k items | `SqliteVecBackend` (default) | none |
| 100k+ or multi-agent | `ChromaDBBackend` | `WKP_BACKEND=chromadb` |
| Enterprise / RHOAI | `PGVectorBackend` | `WKP_BACKEND=memoryhub` |

See [docs/architecture.md](docs/architecture.md) for the full design.

## License

Apache 2.0 — see [LICENSE](LICENSE).
