kontexta-mcp 2.0.2

package/LICENSE

@@ -0,0 +1,191 @@
+
+                                 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 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 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 the 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 any 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
+
+   Copyright 2026 Safiyu
+
+   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.

package/README.md

@@ -0,0 +1,60 @@
+# kontexta-mcp
+
+[![npm](https://img.shields.io/npm/v/kontexta-mcp.svg)](https://www.npmjs.com/package/kontexta-mcp)
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
+
+MCP server for [Kontexta](https://github.com/safiyu/kontexta) — 46 tools that let agents search, read, edit (section-level), tag, version, and clip web content into a local SQLite-backed knowledge base. Designed for context-window economy: every file-returning response is annotated with `est_tokens` and `size_bytes`.
+
+## Install
+
+The server is launched on demand by your AI client; no global install needed.
+
+```json
+{
+  "mcpServers": {
+    "kontexta": {
+      "command": "npx",
+      "args": ["-y", "kontexta-mcp"],
+      "env": {
+        "KONTEXTA_DATA_DIR": "/absolute/path/to/your/data"
+      }
+    }
+  }
+}
+```
+
+`KONTEXTA_DATA_DIR` **must** be an absolute path. The directory is created on first run and holds your SQLite DB plus the markdown files the agent indexes.
+
+## Client config locations
+
+| Client | Path |
+|---|---|
+| Claude Desktop (macOS) | `~/Library/Application Support/Claude/claude_desktop_config.json` |
+| Claude Desktop (Windows) | `%APPDATA%\Claude\claude_desktop_config.json` |
+| Cursor | Settings → Features → MCP |
+| Continue | `~/.continue/config.json` |
+| Codex | `.codex/mcp_servers.json` |
+| Gemini / Antigravity | `~/.gemini/antigravity/mcp_servers.json` |
+
+## Web UI (optional)
+
+The MCP server runs headless. If you want the matching three-pane web UI, run the Docker image alongside it (it reads the same `KONTEXTA_DATA_DIR`):
+
+```bash
+docker run -d -p 3000:3000 -v /absolute/path/to/your/data:/app/data safiyu/kontexta:latest
+```
+
+Open `http://localhost:3000`.
+
+## Requirements
+
+- Node ≥ 20 (the package is published as ESM, target node20).
+- `better-sqlite3` ships prebuilt binaries for linux/macos/windows on x64 and arm64. If your platform isn't covered (Alpine/musl, RISC-V, older Node), `npm install` falls back to a from-source build that needs `python3` and a C++ toolchain.
+
+## Documentation
+
+Full docs, the reference for 46 core + unlimited custom hand tools, and the web UI live in the [main repository](https://github.com/safiyu/kontexta). See [`CHANGELOG.md`](https://github.com/safiyu/kontexta/blob/main/CHANGELOG.md) for what's new.
+
+## License
+
+Apache-2.0

package/dist/agent-rules/rules-block.md

@@ -0,0 +1,164 @@
+<!--
+Source of truth for the kontexta agent rules block.
+
+Authoring rules:
+1. One clause per cell. <= 80 chars. Verbs, no fluff.
+2. "When NOT" is the documented failure mode, not a hypothetical edge case.
+3. "Use instead" is the BETTER sibling tool. Empty if no sibling.
+4. Every row stands alone — no cross-references.
+5. Every new server.tool() in apps/mcp/src/index.ts MUST add a row in the
+   relevant bucket below AND bump rulesVersion in packages/core/package.json.
+   Tests enforce this.
+
+The placeholder {{VERSION}} is substituted at module init with RULE_BLOCK_VERSION.
+-->
+<!-- BEGIN kontexta:rules v{{VERSION}} -->
+## Working with kontexta
+
+This project is registered with kontexta. Honor these rules to keep the index, history, and journal coherent — and to avoid burning tokens on workflows kontexta already solves. Tools live under the `kxta` MCP server.
+
+### Core rules
+
+**Search before reading.** Use `search`, `bundle_search`, or `regex_search` to find context first. Skipping straight to `read_file` on a guessed path wastes tokens and often misses the right file.
+
+**All KB writes go through kontexta.** Use `create_file` / `update_file` / `update_file_section` / `journal_note`. **Never** edit a KB file with raw filesystem tools (Edit/Write/cat) — the watcher and FTS index will diverge until `refresh_index` runs, and subsequent searches will return stale results.
+
+**Batch reads. Don't loop `read_file`.** Need ≥2 files? Call `read_files` (one round-trip, up to 200 IDs) or `bundle_search` (token-budgeted blob). Looping `read_file` wastes round-trips and inflates response overhead.
+
+**Address `journal.suggested_action` before the next tool call.** Many tool responses include a `journal` envelope. If `journal.suggested_action` is set (e.g., `"distill_journal"`), call that tool before issuing your next tool. To dismiss for the rest of the session, pass `journal_acknowledge: true` on your next tool call.
+
+**Use `journal_note(text, tags)` for decisions and abandonments.** When you make a non-obvious call, try something that doesn't work, or capture a workaround, log it. Hands runs are auto-captured now.
+
+**Use `journal_intent(summary)` when the user pivots.** One short sentence so the distillation step knows the topic shifted.
+
+**Strict mode awareness.** If a project sets `journal.mode = "strict"` in its `kontexta.json`, the MCP server returns a `JOURNAL_BACKLOG` error on read tools (search/read_*/list_*) when undistilled events exist. The error includes `next_action: "distill_journal"`. Either run `distill_journal` first, OR pass `journal_bypass: true` on the read call to override (logged for audit).
+
+**Confirm Hands tokens within 60 seconds.** When a Hands tool returns an approval token, do NOT chain a long question or another tool call before `confirm_hand`. Tokens expire; the user will have to re-issue the whole flow.
+
+**Save specs to a canonical location.** When generating a spec, plan, or design doc, write it to the KB at `specs/<project-name>/<spec-name>.md` (use `create_file` with `destination: "knowledge"`, `folder: "specs/<project-name>"`). One folder per project keeps specs queryable.
+
+**Tag new KB files at creation time.** Pass `tags` on `create_file`, or call `add_tags` immediately after. Untagged files are recoverable but invisible to `find_related`.
+
+**`whats_new` early. `commit_backup` late.** Run `whats_new` at session start if you've been away — it returns files added/changed since a cutoff. End the session with `commit_backup` if you mutated KB files and the project has a remote.
+
+**Use `.mmd` for diagrams, not fenced code in `.md`.** When creating an architecture / flow / sequence diagram, call `create_file` with `format: "mmd"` and put the raw mermaid source as the body (no ```` ```mermaid ```` fence). The web UI renders `.mmd` files as live diagrams with SVG/PNG export; mermaid embedded in markdown is just text. Default folder: `mermaid/` (or `<project>/mermaid/` for project-scoped diagrams).
+
+
+### Knowledge Items (KI)
+
+KIs are curated, distilled KB files — the highest-signal context in the vault. 
+They save tokens and prevent redundant research when used correctly.
+
+**Check KIs before independent research.** At the start of any task, run 
+`search` or `bundle_search` over the KB for the task topic. If a matching KI 
+exists, read it before writing code, designing architecture, or forming a plan. 
+Skipping this step is the single most common source of duplicated work.
+
+**KIs are starting points, not ground truth.** KIs are snapshots. Always 
+cross-reference a KI's API patterns, file paths, and config values against the 
+*current* source on disk before acting on them. KIs can lag behind code.
+
+**Close the loop: update the KI after significant changes.** When you ship a 
+meaningful change (new API, config schema change, architecture shift), update 
+the relevant KI via `update_file` or `update_file_section`. If no KI exists 
+yet, create one with `create_file` under `knowledge/` with appropriate tags. 
+A KI that isn't maintained becomes noise — which is worse than no KI.
+
+**Use `whats_new` at session start after a gap.** If you haven't touched the 
+project in a while, run `whats_new(since: "7d")` to surface recently changed 
+files — including KIs updated by other agents or the user.
+
+### Tool reference
+
+The matrix below is grouped by intent. For each tool: when to reach for it, the most common wrong context, and the better sibling tool when wrong.
+
+#### Find
+
+| Tool | When | Not when | Use instead |
+|---|---|---|---|
+| `search` | Natural-language keyword across KB (FTS) | Substrings, URLs, code idents | `regex_search` |
+| `regex_search` | Substrings, URLs, code identifiers | Natural-language queries | `search` |
+| `grep_in_file` | Substring/regex within ONE known file | Searching across files | `regex_search` |
+| `bundle_search` | Need search hits + bodies in a token budget | Only need IDs | `search` |
+| `find_related` | Discover siblings via tag overlap | Text content matching | `search` |
+| `suggest_tags` | Propose tags for an existing file | Finding files by tag | `find_related` |
+
+#### Read
+
+| Tool | When | Not when | Use instead |
+|---|---|---|---|
+| `read_file` | One file ID, full body | ≥2 file IDs | `read_files` |
+| `read_files` | 2–200 file IDs in one call | Only need a section of one file | `read_section` |
+| `read_file_by_path` | Known absolute path, no ID handy | You already have the ID | `read_file` |
+| `read_file_lines` | Known line range | Guessing line numbers | `read_section` |
+| `read_section` | Known heading | Need the whole file | `read_file` |
+| `read_file_outline` | Triaging an unfamiliar file's structure | Structure already known | `describe_file` |
+| `describe_file` | Metadata only (size, tags, mtime) | Need content | `read_file` |
+
+#### Write
+
+| Tool | When | Not when | Use instead |
+|---|---|---|---|
+| `create_file` | One new file (md or mmd via `format`) | Bulk-creating ≥2 files | `create_files` |
+| `create_files` | 2+ new files in one call | Single file | `create_file` |
+| `update_file` | Replacing the whole body | Editing one section | `update_file_section` |
+| `update_file_section` | Surgical edit at a known heading | Replacing the whole file | `update_file` |
+| `delete_file` | One file | Bulk delete | `delete_files` |
+| `delete_files` | 2+ files in one call | Single file | `delete_file` |
+| `move_file` | Rename or relocate a file | File content needs changing | `update_file` |
+
+#### Organize
+
+| Tool | When | Not when | Use instead |
+|---|---|---|---|
+| `add_tags` | Tag an existing file | Tagging at creation time | `create_file` (with `tags` param) |
+| `remove_tags` | Untag a file | Want to delete the file | `delete_file` |
+| `list_tags` | Enumerate all tags in the vault | Want files for a given tag | `find_related` |
+| `set_favorite` | Pin / unpin a file | Semantic categorization | `add_tags` |
+| `tag_search_results` | Bulk-tag every hit from a search | Tagging a single file | `add_tags` |
+| `journal_note` | Log a decision, workaround, or abandonment | Editing regular content | `update_file` |
+| `journal_intent` | Record a user-initiated topic pivot | Auto-captured tool calls | `journal_note` |
+| `journal_append` | Append timestamped text to today's daily KB journal file | Structured notes | `journal_note` |
+| `distill_journal` | Summarize accumulated journal events | Individual events | `journal_note` |
+| `clip_url` | Capture a web URL into the KB | Saving a local file | `create_file` |
+| `list_folders` | Enumerate folders in the project | Finding files | `list_files` |
+| `create_folder` | Create a new (possibly nested) folder | Files don't need explicit folders | |
+| `delete_folder` | Remove an empty folder | Folder still has files | `delete_files` first |
+
+#### History & recovery
+
+| Tool | When | Not when | Use instead |
+|---|---|---|---|
+| `get_history` | List a file's revisions | Want a diff between two revisions | `get_diff` |
+| `get_diff` | Compare two specific revisions | Want full content of one | `restore_file` |
+| `restore_file` | Roll back a KB file to an earlier revision | Want to use raw `git` | |
+| `diff_against_disk` | Find drift after raw filesystem edits | Normal search staleness | `refresh_index` |
+| `refresh_index` | Rescan after out-of-band changes | Normal in-app edits | |
+| `commit_backup` | Push KB changes to remote git | Local-only work | |
+
+#### Discover
+
+| Tool | When | Not when | Use instead |
+|---|---|---|---|
+| `list_projects` | Enumerate registered projects | Files within one project | `list_files` |
+| `list_files` | Files in a project (filterable) | Full-text content matters | `search` |
+| `project_map` | Folder/file tree for a project | Flat file list | `list_files` |
+| `stats` | Counts and health for a project | Per-file detail | `describe_file` |
+| `whats_new` | Files added/changed since a cutoff | Full-text search | `search` |
+
+#### Hands (project tools)
+
+| Tool | When | Not when | Use instead |
+|---|---|---|---|
+| `list_hands` | Enumerate Hands tools available in this project | Want the YAML schema | `describe_hands_schema` |
+| `describe_hands_schema` | Explain the `hands.yaml` format | Listing tools | `list_hands` |
+| `confirm_hand` | Approve a Hands token within 60s of issue | Normal MCP tool calls | |
+| `reload_hands` | Re-read `hands.yaml` after editing it | First-time use (auto-loads) | |
+
+#### Onboarding
+
+| Tool | When | Not when | Use instead |
+|---|---|---|---|
+| `register_project` | Register a new project root with kontexta | Already registered | `list_projects` |
+| `onboard_agent` | Write/update the rules block in CLAUDE.md / AGENTS.md / etc. | Editing regular project content | `update_file` |
+<!-- END kontexta:rules v{{VERSION}} -->