coding-friend-cli 1.37.0 → 1.38.0

package/lib/learn-mcp/README.md

@@ -1,187 +0,0 @@
-# coding-friend-learn-mcp
-
-MCP (Model Context Protocol) server that exposes your `/cf-learn` docs as tools for Claude — letting Claude read, search, write, and improve your learning notes directly.
-
-## Usage (via CLI)
-
-```bash
-cf mcp                     # setup MCP for docs/learn/
-cf mcp ./my-docs           # setup MCP for a custom directory
-```
-
-The CLI builds the server and prints the config to add to Claude Desktop / Claude Code.
-
-## Local Development
-
-Run the server directly without the CLI — useful when working on tools or docs logic.
-
-### 1. Install dependencies
-
-```bash
-cd cli/lib/learn-mcp
-npm install
-```
-
-### 2. Run with tsx (no build needed)
-
-The server accepts the docs directory as the first CLI argument, or via `LEARN_DOCS_DIR` env var.
-
-```bash
-# Using argument
-npx tsx src/index.ts /path/to/your/docs/learn
-
-# Using env var
-LEARN_DOCS_DIR=/path/to/your/docs/learn npx tsx src/index.ts
-
-# Point to this repo's own learn docs
-npx tsx src/index.ts ../../../docs/learn
-```
-
-The server communicates over stdio (MCP protocol), so you won't see output when running manually — it's meant to be connected to Claude.
-
-### 3. Connect to Claude Code (dev mode)
-
-Add to your project's `.mcp.json`:
-
-```json
-{
-  "mcpServers": {
-    "coding-friend-learn": {
-      "type": "stdio",
-      "command": "npx",
-      "args": [
-        "tsx",
-        "/path/to/coding-friend/cli/lib/learn-mcp/src/index.ts",
-        "/path/to/your/docs/learn"
-      ]
-    }
-  }
-}
-```
-
-Or for Claude Desktop, add to `~/Library/Application Support/Claude/claude_desktop_config.json`:
-
-```json
-{
-  "mcpServers": {
-    "coding-friend-learn": {
-      "command": "npx",
-      "args": [
-        "tsx",
-        "/path/to/coding-friend/cli/lib/learn-mcp/src/index.ts",
-        "/path/to/your/docs/learn"
-      ]
-    }
-  }
-}
-```
-
-### 4. Watch mode (auto-rebuild)
-
-Keep a terminal running to auto-rebuild on every file change:
-
-```bash
-npm run dev:watch
-```
-
-Then restart the MCP server in Claude Code (`/mcp` → restart) to pick up the latest changes.
-
-### 5. Build and run compiled
-
-```bash
-npm run build
-node dist/index.js /path/to/docs/learn
-```
-
-For Claude Desktop with the compiled version:
-
-```json
-{
-  "mcpServers": {
-    "coding-friend-learn": {
-      "command": "node",
-      "args": [
-        "/path/to/coding-friend/cli/lib/learn-mcp/dist/index.js",
-        "/path/to/your/docs/learn"
-      ]
-    }
-  }
-}
-```
-
-> **Note:** The path must include `/cli/lib/learn-mcp/`, not `/lib/learn-mcp/`. Run `npm run build` first to generate `dist/`.
-
-## Docs Directory Structure
-
-```
-docs/
-└── learn/
-    ├── category-one/
-    │   ├── my-doc.md
-    │   └── another-doc.md
-    └── category-two/
-        └── some-doc.md
-```
-
-Each `.md` file needs frontmatter:
-
-```md
----
-title: My Doc Title
-category: category-one
-tags: [typescript, patterns]
-created: 2025-01-01
-updated: 2025-01-15
----
-
-Content here...
-```
-
-## Available Tools
-
-| Tool              | Type  | Description                                      |
-| ----------------- | ----- | ------------------------------------------------ |
-| `list-categories` | Read  | List all doc categories                          |
-| `list-docs`       | Read  | List docs (optionally filter by category or tag) |
-| `read-doc`        | Read  | Read a specific doc by category + slug           |
-| `search-docs`     | Read  | Full-text search across all docs                 |
-| `get-review-list` | Read  | Get docs needing review                          |
-| `create-doc`      | Write | Create a new doc with frontmatter                |
-| `update-doc`      | Write | Append content or update tags on an existing doc |
-| `improve-doc`     | Write | Replace doc content while preserving frontmatter |
-| `track-knowledge` | Write | Mark a doc as remembered / needs-review / new    |
-
-## Structure
-
-```
-src/
-├── index.ts          # Entry: parses docs dir, starts MCP server
-├── server.ts         # Registers all tools
-├── bin/
-│   └── learn-mcp.ts  # CLI binary entry
-├── tools/            # One file per MCP tool
-│   ├── list-categories.ts
-│   ├── list-docs.ts
-│   ├── read-doc.ts
-│   ├── search-docs.ts
-│   ├── create-doc.ts
-│   ├── update-doc.ts
-│   ├── improve-doc.ts
-│   ├── track-knowledge.ts
-│   └── get-review-list.ts
-└── lib/
-    ├── docs.ts       # Shared doc utilities (read, write, search)
-    ├── types.ts      # TypeScript interfaces
-    └── knowledge.ts  # Knowledge tracking state
-```
-
-## How It Fits Together
-
-```
-cf mcp [path]
-  └─ resolves docs dir
-  └─ npm install + build (one-time)
-  └─ prints MCP config to add to Claude
-```
-
-Once configured, Claude can call these tools directly to read and write your learning notes without leaving the conversation.

package/lib/learn-mcp/src/__tests__/docs.test.ts

@@ -1,117 +0,0 @@
-import fs from "node:fs";
-import matter from "gray-matter";
-import os from "node:os";
-import path from "node:path";
-import { afterEach, beforeEach, describe, expect, it } from "vitest";
-import { createDoc, readDoc, updateDoc } from "../lib/docs.js";
-
-/**
- * Place a valid .md file outside docsDir so traversal attempts
- * actually find a file — this proves the guard blocks the read,
- * not just "file not found".
- */
-function placeTrapFile(dir: string, name: string): string {
-  fs.mkdirSync(dir, { recursive: true });
-  const filePath = path.join(dir, name);
-  const content = matter.stringify("SECRET CONTENT", {
-    title: "Trap",
-    category: "trap",
-    tags: [],
-    created: "2026-01-01",
-    updated: "2026-01-01",
-  });
-  fs.writeFileSync(filePath, content, "utf-8");
-  return filePath;
-}
-
-describe("docs path traversal protection", () => {
-  let tmpDir: string;
-  let docsDir: string;
-
-  beforeEach(() => {
-    tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "learn-mcp-test-"));
-    docsDir = path.join(tmpDir, "docs");
-    fs.mkdirSync(docsDir, { recursive: true });
-
-    // Create a legitimate doc for testing
-    createDoc(docsDir, "javascript", "test-doc", ["test"], "Hello world");
-  });
-
-  afterEach(() => {
-    fs.rmSync(tmpDir, { recursive: true, force: true });
-  });
-
-  describe("readDoc", () => {
-    it("reads legitimate docs normally", () => {
-      const doc = readDoc(docsDir, "javascript", "test-doc");
-      expect(doc).not.toBeNull();
-      expect(doc!.content).toContain("Hello world");
-    });
-
-    it("rejects path traversal in category", () => {
-      // Place a trap file at tmpDir/secret.md (one level above docsDir)
-      placeTrapFile(tmpDir, "secret.md");
-      const doc = readDoc(docsDir, "..", "secret");
-      expect(doc).toBeNull();
-    });
-
-    it("rejects path traversal in slug", () => {
-      placeTrapFile(tmpDir, "secret.md");
-      const doc = readDoc(docsDir, "javascript", "../../secret");
-      expect(doc).toBeNull();
-    });
-
-    it("rejects path traversal with nested sequences", () => {
-      placeTrapFile(tmpDir, "secret.md");
-      const doc = readDoc(docsDir, "javascript/../../..", "secret");
-      expect(doc).toBeNull();
-    });
-  });
-
-  describe("createDoc", () => {
-    it("creates legitimate docs normally", () => {
-      const filePath = createDoc(
-        docsDir,
-        "python",
-        "New Doc",
-        ["tag1"],
-        "Content",
-      );
-      expect(filePath).toContain(docsDir);
-      expect(fs.existsSync(filePath)).toBe(true);
-    });
-
-    it("rejects path traversal in category", () => {
-      expect(() =>
-        createDoc(docsDir, "../escape", "title", [], "content"),
-      ).toThrow();
-      // Verify no file was created outside docsDir
-      expect(fs.existsSync(path.join(tmpDir, "escape"))).toBe(false);
-    });
-  });
-
-  describe("updateDoc", () => {
-    it("updates legitimate docs normally", () => {
-      const result = updateDoc(docsDir, "javascript", "test-doc", {
-        title: "Updated",
-      });
-      expect(result).not.toBeNull();
-    });
-
-    it("rejects path traversal in category", () => {
-      placeTrapFile(tmpDir, "secret.md");
-      const result = updateDoc(docsDir, "..", "secret", {
-        title: "hack",
-      });
-      expect(result).toBeNull();
-    });
-
-    it("rejects path traversal in slug", () => {
-      placeTrapFile(tmpDir, "secret.md");
-      const result = updateDoc(docsDir, "javascript", "../../secret", {
-        title: "hack",
-      });
-      expect(result).toBeNull();
-    });
-  });
-});

package/lib/learn-mcp/vitest.config.ts

@@ -1,8 +0,0 @@
-import { defineConfig } from "vitest/config";
-
-export default defineConfig({
-  test: {
-    environment: "node",
-    exclude: ["dist/**", "node_modules/**"],
-  },
-});