inkdex 0.0.1

package/.claude/settings.local.json

@@ -0,0 +1,15 @@
+{
+  "permissions": {
+    "allow": [
+      "WebFetch(domain:github.com)",
+      "mcp__acp__Bash",
+      "mcp__acp__Write",
+      "mcp__acp__Edit",
+      "WebFetch(domain:raw.githubusercontent.com)",
+      "WebFetch(domain:api.github.com)",
+      "WebFetch(domain:www.firecrawl.dev)",
+      "WebFetch(domain:unstructured.io)",
+      "WebFetch(domain:www.npmjs.com)"
+    ]
+  }
+}

package/.github/workflows/ci.yml

@@ -0,0 +1,73 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - "src/**"
+      - "test/**"
+      - "package.json"
+      - "package-lock.json"
+      - "tsconfig.json"
+      - ".github/workflows/**"
+  pull_request:
+    branches: [main]
+    paths:
+      - "src/**"
+      - "test/**"
+      - "package.json"
+      - "package-lock.json"
+      - "tsconfig.json"
+      - ".github/workflows/**"
+
+jobs:
+  audit:
+    name: Security Audit
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - uses: actions/setup-node@v6
+        with:
+          node-version: "22"
+
+      - run: npm audit --audit-level=critical
+
+  check:
+    name: Lint & Format
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - uses: actions/setup-node@v6
+        with:
+          node-version: "22"
+
+      - run: npm ci
+      - run: npm run check
+
+  test-unit:
+    name: Unit Tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - uses: actions/setup-node@v6
+        with:
+          node-version: "22"
+
+      - run: npm ci
+      - run: npm run test:unit
+
+  test-integration:
+    name: Integration Tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - uses: actions/setup-node@v6
+        with:
+          node-version: "22"
+
+      - run: npm ci
+      - run: npm run test:integration

package/.github/workflows/release.yml

@@ -0,0 +1,65 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  check:
+    name: Check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - uses: actions/setup-node@v6
+        with:
+          node-version: "22"
+
+      - run: npm ci
+      - run: npm run check
+
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - uses: actions/setup-node@v6
+        with:
+          node-version: "22"
+
+      - run: npm ci
+      - run: npm run test
+
+  npm:
+    name: npm
+    needs: [check, test]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - uses: actions/setup-node@v6
+        with:
+          node-version: "22"
+          registry-url: "https://registry.npmjs.org"
+
+      - run: npm install -g npm@latest
+      - run: npm ci
+      - run: npm run build
+      - run: npm publish --access public --provenance
+
+  release:
+    name: Release
+    needs: [npm]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - uses: softprops/action-gh-release@v2
+        with:
+          generate_release_notes: true

package/AGENTS.md

@@ -0,0 +1,32 @@
+# AGENTS.md
+
+- Use [Conventional Commits](https://www.conventionalcommits.org/) (`feat:`, `fix:`, `chore:`, `docs:`)
+
+## General Coding Guidelines
+
+- Maintain consistency with existing patterns and style in the codebase
+- Use TypeScript strictly: enable `strict: true`, prefer `unknown` over `any`, avoid type assertions unless necessary
+- Write comments that explain *why*, not *what*—update or remove stale comments when modifying code
+- Prefer renaming over commenting: if code needs a comment to explain what it does, rename instead
+- Use JSDoc (`/** */`) only for exported functions/types; use `//` for implementation notes
+- Use `@package` on exports internal to their feature package
+- Include `@example` in JSDoc when input/output isn't obvious from the signature
+- No commented-out code, no TODO/FIXME without a linked issue
+- Naming: camelCase functions/variables, PascalCase types/classes, UPPER_SNAKE_CASE constants; prefix booleans with `is`/`has`/`should`
+- Keep functions focused and single-responsibility; favor immutable patterns (`readonly`, no mutation)
+- Handle errors consistently: prefer typed errors or Result patterns, handle promise rejections explicitly
+- Use modern syntax: optional chaining (`?.`), nullish coalescing (`??`), `satisfies`, ES modules
+- After refactoring, run `npm run test` to verify tests pass and coverage requirements are met
+- Write tests covering happy path, edge cases, and error conditions with descriptive names
+- Test should validate observable behavior not implementation details
+
+## Development
+
+```bash
+npm install
+npm run build       # TypeScript compilation
+npm run dev         # Run via tsx
+npm run check       # Biome lint
+npm run format      # Biome format
+npm test            # Unit + integration
+```

package/LICENSE

@@ -0,0 +1,190 @@
+                                 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 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
+
+   Copyright 2026 Anton Lundén
+
+   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,40 @@
+# Inkdex
+
+Inkdex is a MCP server that makes your markdown docs searchable for AI. Point it at your docs directory, get hybrid search (text + vector) powered by local AI embeddings.
+
+## Tools
+
+| Tool | Description |
+|------|-------------|
+| `search_docs` | Search indexed documentation. Returns matching chunks ranked by relevance. |
+
+## Usage
+
+Add to your MCP client configuration:
+
+```json
+{
+  "mcpServers": {
+    "inkdex": {
+      "command": "npx",
+      "args": [
+        "-y",
+        "inkdex"
+      ],
+      "env": {
+        "DOCS_PATH": "/path/to/your/docs"
+      }
+    }
+  }
+}
+```
+
+| Variable | Required | Description |
+|----------|----------|-------------|
+| `DOCS_PATH` | Yes | Path to the directory containing markdown files to index |
+
+To expose docs remotely, use a MCP gateway like [MCPBox](https://github.com/kandobyte/mcpbox).
+
+## How it works
+
+Documents are split along heading boundaries with overlap to preserve context. Chunks are embedded locally and stored in SQLite for hybrid retrieval. Indexing runs on startup and is incremental — only changed files are re-processed.

package/biome.json

@@ -0,0 +1,43 @@
+{
+  "$schema": "https://biomejs.dev/schemas/2.3.14/schema.json",
+  "vcs": {
+    "enabled": true,
+    "clientKind": "git",
+    "useIgnoreFile": true
+  },
+  "assist": { "actions": { "source": { "organizeImports": "on" } } },
+  "formatter": {
+    "indentStyle": "space",
+    "indentWidth": 2
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": true,
+      "suspicious": {
+        "noExplicitAny": "error"
+      },
+      "performance": {
+        "noDelete": "off"
+      },
+      "correctness": {
+        "noPrivateImports": "error"
+      }
+    }
+  },
+  "overrides": [
+    {
+      "includes": ["test/**"],
+      "linter": {
+        "rules": {
+          "correctness": {
+            "noPrivateImports": "off"
+          }
+        }
+      }
+    }
+  ],
+  "files": {
+    "includes": ["**", "!**/dist", "!**/node_modules"]
+  }
+}

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli.js

@@ -0,0 +1,38 @@
+#!/usr/bin/env node
+import { stat } from "node:fs/promises";
+import { resolve } from "node:path";
+import { Embedder } from "./embedder/embedder.js";
+import { indexDocs } from "./ingest/index-docs.js";
+import { logger } from "./logger.js";
+import { startServer } from "./server.js";
+import { closeDb, openDb } from "./store/db.js";
+process.on("uncaughtException", (error) => {
+    logger.error({ error }, "Uncaught exception");
+    process.exit(1);
+});
+process.on("unhandledRejection", (reason) => {
+    logger.error({ reason }, "Unhandled rejection");
+    process.exit(1);
+});
+async function main() {
+    const docsPath = process.env.DOCS_PATH;
+    if (!docsPath) {
+        logger.error("DOCS_PATH environment variable is required");
+        process.exit(1);
+    }
+    const resolved = resolve(docsPath);
+    const info = await stat(resolved).catch(() => null);
+    if (!info?.isDirectory()) {
+        logger.error({ path: resolved }, "DOCS_PATH is not a directory");
+        process.exit(1);
+    }
+    const embedder = await Embedder.load();
+    openDb(resolved);
+    await indexDocs(embedder, resolved);
+    await startServer(embedder);
+}
+main().catch((error) => {
+    closeDb();
+    logger.error({ error }, "Failed to start server");
+    process.exit(1);
+});

package/dist/embedder/embedder.d.ts

@@ -0,0 +1,9 @@
+export declare class Embedder {
+    readonly maxTokens: number;
+    private readonly pipeline;
+    private constructor();
+    static load(): Promise<Embedder>;
+    tokenize(text: string): number[];
+    embed(text: string): Promise<number[]>;
+    embedBatch(texts: string[]): Promise<number[][]>;
+}

package/dist/embedder/embedder.js

@@ -0,0 +1,39 @@
+import { pipeline } from "@huggingface/transformers";
+const MODEL = "Xenova/all-MiniLM-L6-v2";
+const BATCH_SIZE = 32;
+export class Embedder {
+    maxTokens;
+    pipeline;
+    constructor(pipe) {
+        this.pipeline = pipe;
+        this.maxTokens = pipe.tokenizer.model_max_length ?? 256;
+    }
+    static async load() {
+        const pipe = await pipeline("feature-extraction", MODEL);
+        return new Embedder(pipe);
+    }
+    tokenize(text) {
+        return this.pipeline.tokenizer.encode(text);
+    }
+    async embed(text) {
+        const result = await this.pipeline(text, {
+            pooling: "mean",
+            normalize: true,
+        });
+        return result.tolist()[0];
+    }
+    async embedBatch(texts) {
+        if (texts.length === 0)
+            return [];
+        const results = [];
+        for (let i = 0; i < texts.length; i += BATCH_SIZE) {
+            const batch = texts.slice(i, i + BATCH_SIZE);
+            const result = await this.pipeline(batch, {
+                pooling: "mean",
+                normalize: true,
+            });
+            results.push(...result.tolist());
+        }
+        return results;
+    }
+}

package/dist/ingest/chunker.d.ts

@@ -0,0 +1,7 @@
+import type { BaseChunk } from "../types.js";
+export interface ChunkOptions {
+    readonly maxTokens: number;
+    readonly countTokens: (text: string) => number;
+}
+/** @package */
+export declare function chunkMarkdown(content: string, path: string, options: ChunkOptions): BaseChunk[];

package/dist/ingest/chunker.js

@@ -0,0 +1,114 @@
+import { basename } from "node:path";
+import matter from "gray-matter";
+const OVERLAP_RATIO = 0.1;
+const SUB_SEPARATORS = [/^### /m, /\n\n/, /\. /];
+function extractH1(body) {
+    const match = body.match(/^# (.+)$/m);
+    return match ? match[1].trim() : null;
+}
+function clean(text) {
+    return text
+        .replace(/<!--.*?-->/gs, "")
+        .replace(/\n{3,}/g, "\n\n")
+        .trim();
+}
+function splitWithOverlap(text, separators, maxTokens, overlap, countTokens) {
+    if (countTokens(text) <= maxTokens)
+        return [text];
+    const separator = separators[0];
+    const remaining = separators.slice(1);
+    const parts = text.split(separator).filter((p) => p.trim());
+    if (parts.length <= 1) {
+        // Separator didn't help — try the next one
+        if (remaining.length > 0) {
+            return splitWithOverlap(text, remaining, maxTokens, overlap, countTokens);
+        }
+        // Last resort: hard split
+        return hardSplit(text, maxTokens, overlap, countTokens);
+    }
+    const chunks = [];
+    let current = "";
+    for (const part of parts) {
+        const combined = current ? `${current}\n\n${part}` : part;
+        if (current && countTokens(combined) > maxTokens) {
+            chunks.push(current.trim());
+            // Start next chunk with overlap from the end of the previous
+            const overlapText = current.slice(-overlap);
+            current = overlapText + part;
+        }
+        else {
+            current = combined;
+        }
+    }
+    if (current.trim())
+        chunks.push(current.trim());
+    // Recursively split any chunks that are still too large
+    return chunks.flatMap((chunk) => {
+        if (countTokens(chunk) <= maxTokens)
+            return [chunk];
+        if (remaining.length > 0) {
+            return splitWithOverlap(chunk, remaining, maxTokens, overlap, countTokens);
+        }
+        return hardSplit(chunk, maxTokens, overlap, countTokens);
+    });
+}
+function hardSplit(text, maxTokens, overlap, countTokens) {
+    const chunks = [];
+    const words = text.split(/\s+/);
+    let current = "";
+    for (const word of words) {
+        const next = current ? `${current} ${word}` : word;
+        if (countTokens(next) > maxTokens && current) {
+            chunks.push(current.trim());
+            // Keep overlap from end of current chunk
+            const overlapText = current.slice(-overlap);
+            current = overlapText + word;
+        }
+        else {
+            current = next;
+        }
+    }
+    if (current.trim())
+        chunks.push(current.trim());
+    return chunks;
+}
+/** @package */
+export function chunkMarkdown(content, path, options) {
+    const { maxTokens, countTokens } = options;
+    const overlap = Math.floor(maxTokens * OVERLAP_RATIO);
+    const { data: metadata, content: body } = matter(content);
+    const fileHeading = extractH1(body) || basename(path, ".md");
+    const sections = body.split(/^## /m);
+    const chunks = [];
+    for (let i = 0; i < sections.length; i++) {
+        const section = sections[i];
+        if (!section.trim())
+            continue;
+        let heading;
+        let text;
+        if (i === 0) {
+            // Content before the first ## — strip the H1 line and use fileHeading
+            heading = fileHeading;
+            const withoutH1 = section.replace(/^# .+$/m, "");
+            text = clean(withoutH1);
+        }
+        else {
+            const [headingLine, ...rest] = section.split("\n");
+            heading = headingLine.trim();
+            text = clean(rest.join("\n"));
+        }
+        if (!text)
+            continue;
+        const subChunks = splitWithOverlap(text, SUB_SEPARATORS, maxTokens, overlap, countTokens);
+        for (const sub of subChunks) {
+            chunks.push({
+                path,
+                fileHeading,
+                heading,
+                text: sub,
+                metadata,
+            });
+        }
+    }
+    return chunks;
+}

package/dist/ingest/index-docs.d.ts

@@ -0,0 +1,2 @@
+import type { Embedder } from "../embedder/embedder.js";
+export declare function indexDocs(embedder: Embedder, docsPath: string): Promise<void>;