From 0c6ed9f14e5ff2d98ec3742af8f20f29398c6c91 Mon Sep 17 00:00:00 2001
From: Fadhli Azhari <fadhli@kollect.biz>
Date: Thu, 12 Mar 2026 17:11:10 +0800
Subject: [PATCH] docs: update CLAUDE.md and README.md with just commands and
 gitignore info

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
---
 CLAUDE.md | 17 ++++++++++++++---
 README.md | 28 ++++++++++++++++++++++++----
 2 files changed, 38 insertions(+), 7 deletions(-)

diff --git a/CLAUDE.md b/CLAUDE.md
index 05f8908..57adafa 100644
--- a/CLAUDE.md
+++ b/CLAUDE.md
@@ -26,13 +26,24 @@ src/
 ## Commands
 
 ```bash
-pnpm build          # Compile TypeScript to dist/
-pnpm start          # Run compiled server (requires build first)
-pnpm dev            # Run directly with tsx (no build needed)
+just install        # Install Node.js dependencies (pnpm install)
+just build          # Compile TypeScript to dist/
+just start          # Run compiled server (requires build first)
+just dev            # Run directly with tsx (no build needed)
 just bootstrap      # Full setup: uv, just, commitizen, pre-commit, git hooks
 just setup          # Install commitizen + pre-commit hooks only
+just update         # Refresh pre-commit hook versions
+just changelog      # Generate CHANGELOG.md from commit history
+just bump           # Bump version based on commit history
 ```
 
+## Gitignored (do not commit)
+
+- `.env` — contains API keys
+- `.mcp.json` — contains API keys (use `.mcp.json.example` as template)
+- `.claude/settings.local.json` — local Claude Code permissions
+- `node_modules/`, `dist/` — build artifacts
+
 ## Environment Variables
 
 - `OPENPROJECT_URL` — Base URL of the OpenProject instance (e.g. `https://openproject.kollect.biz/openproject`)
diff --git a/README.md b/README.md
index 643a321..9d88393 100644
--- a/README.md
+++ b/README.md
@@ -17,18 +17,20 @@ A [Model Context Protocol](https://modelcontextprotocol.io/) (MCP) server that c
 
 ## Setup
 
-1. **Clone and install:**
+1. **Clone and bootstrap:**
 
    ```bash
    git clone https://gitea.kollect.biz/KollectRnD/MCP-OpenProject.git
    cd MCP-OpenProject
-   pnpm install
+   just bootstrap    # installs uv, just, commitizen, pre-commit, git hooks
+   just install      # pnpm install
    ```
 
 2. **Configure environment:**
 
    ```bash
    cp .env.example .env
+   cp .mcp.json.example .mcp.json
    ```
 
    Edit `.env` with your OpenProject URL and API key:
@@ -38,10 +40,14 @@ A [Model Context Protocol](https://modelcontextprotocol.io/) (MCP) server that c
    OPENPROJECT_API_KEY=your-api-key-here
    ```
 
+   Edit `.mcp.json` and replace `<YOUR_API_KEY_HERE>` with your key.
+
+   > **Note:** `.env` and `.mcp.json` are gitignored — secrets stay local.
+
 3. **Build:**
 
    ```bash
-   pnpm build
+   just build
    ```
 
 ## Usage
@@ -89,7 +95,21 @@ Add to your Claude Desktop config (`%APPDATA%\Claude\claude_desktop_config.json`
 Run directly without building:
 
 ```bash
-pnpm dev
+just dev
+```
+
+### Just Commands
+
+```bash
+just install      # Install dependencies
+just build        # Compile TypeScript
+just dev          # Run with tsx (no build)
+just start        # Run compiled server
+just bootstrap    # Full setup (first time)
+just setup        # Install commitizen + pre-commit
+just update       # Update pre-commit hooks
+just changelog    # Generate CHANGELOG.md
+just bump         # Bump version (SemVer)
 ```
 
 ## Available Tools