Skip to main content
Glama
README.md
# book-notes-mcp

ビジネス書の読書ノートを構造化 YAML で管理し、MCP サーバー経由で AI エージェントから検索・参照できるナレッジベース。

**特徴**
- LLM API に一切依存しない(月 $0)
- GitHub 公開リポジトリ前提のセキュリティ設計
- SQLite FTS5 による日英全文検索
- 7 つの MCP Tool で AI エージェントからアクセス可能

---

## Quick Start

```bash
git clone https://github.com/YOUR_NAME/book-notes-mcp
cd book-notes-mcp
npm ci --ignore-scripts

# インデックスを構築
npm run index build

# Claude Desktop に MCP サーバーを登録
# ~/.config/claude/claude_desktop_config.json に追記:
```

```json
{
  "mcpServers": {
    "book-notes": {
      "command": "npx",
      "args": ["tsx", "/path/to/book-notes-mcp/mcp-server/src/index.ts"],
      "env": { "DB_PATH": "/path/to/book-notes-mcp/books.db" }
    }
  }
}
```

---

## Docker で使う

### イメージのビルド

```bash
docker build -t book-notes-mcp .
```

### Claude Desktop に登録(Docker 経由)

`~/.config/claude/claude_desktop_config.json` に追記:

```json
{
  "mcpServers": {
    "book-notes": {
      "command": "docker",
      "args": [
        "run", "--rm", "-i",
        "-v", "/path/to/book-notes-mcp/books:/app/books:ro",
        "-v", "/path/to/book-notes-mcp/memos:/app/memos:ro",
        "-v", "/path/to/book-notes-mcp/inbox:/app/inbox",
        "-v", "book-notes-db:/app/db",
        "-e", "DB_PATH=/app/db/books.db",
        "book-notes-mcp"
      ]
    }
  }
}
```

### CLI コマンドを Docker で実行

```bash
docker compose run --rm book-notes-mcp npm run sync
docker compose run --rm book-notes-mcp npm run validate
docker compose run --rm book-notes-mcp npm run index build
```

---

## 使い方

### 1. 読書ノートを構造化する

```bash
# inbox/ に走り書きを置く(gitignore対象)
cp your-notes.md inbox/

# 手元の AI CLI で YAML を生成
cat prompts/structure.md inbox/your-notes.md | claude > books/your-book-author-2024.yaml

# ノートを置いたら sync 一発で完了
npm run sync
```

`sync` は以下を順番に実行します。途中でエラーがあればそのステップで止まり、修正すべき内容とヒントを表示します。

```
[1/5] Validating...       # スキーマ + ビジネスルール検証
[2/5] Formatting...       # YAML フィールド順正規化
[3/5] Enriching metadata  # OpenBD からメタデータ自動補完
[4/5] Checking references # connections 参照整合性チェック
[5/5] Building index...   # SQLite インデックス再構築
```

### 2. 読書メモ(Markdown)

`add` を実行すると YAML と同時に `memos/<slug>.md` が自動生成されます。タイトル・著者・ISBN などの情報が事前入力された状態で作られるので、空欄を埋めるだけです。

```markdown
# 複利で伸びる1つの習慣

| | |
|---|---|
| 著者 | James Clear |
| 原題 | Atomic Habits |
| 出版年 | 2018 |
| ISBN | 9780735211292 |
| ステータス | to-read |
| URL | |

---

## なぜ読む
## 読書メモ
## 重要概念
## 印象に残った言葉
## アクション
```

メモは `memos/` ディレクトリに保存され、Git で管理されます。

### 3. CLI コマンド一覧

```bash
# ── 基本ワークフロー ──────────────────────────────────────────────────
npm run sync                             # 全パイプラインを一括実行(推奨)
npm run sync -- --skip-enrich            # ネットワーク不要モード
npm run sync -- books/foo-bar-2024.yaml  # 特定ファイルのみ処理

# ── メモ管理 ──────────────────────────────────────────────────────────
npm run add                              # 対話式でエントリ作成 → メモも自動生成
npm run memo:new                         # 既存 YAML からメモを一括生成
npm run memo:new -- books/foo.yaml       # 特定ファイルのメモを生成
npm run memo:format                      # 全メモの空白・改行を正規化
npm run memo:format -- --check           # フォーマットが必要なファイルを検出のみ

# ── 個別コマンド ──────────────────────────────────────────────────────
npm run validate -- books/               # スキーマ検証
npm run validate -- books/ --strict      # 引用文字数エラーも検出
npm run format -- books/                 # YAML 整形
npm run enrich -- books/                 # OpenBD メタデータ補完
npm run check-refs                       # connections の参照整合性チェック
npm run index build                      # SQLite インデックス構築
```

### 3. MCP Tools

| Tool | 説明 |
|---|---|
| `list_books` | フィルタ付き蔵書一覧 |
| `get_book` | 1 冊の詳細取得 |
| `search_books` | 全文検索(タイトル・著者・サマリー) |
| `search_highlights` | ハイライト横断検索 |
| `search_concepts` | 概念横断検索 |
| `find_connections` | 関連書籍グラフ(depth 1 or 2) |
| `get_actionable_insights` | アクションアイテム抽出 |

---

## Book Entry YAML フォーマット

`books/` ディレクトリの各 YAML ファイルが 1 冊に対応します。

ファイル名: `{title-slug}-{author-family}-{year}.yaml`(例: `atomic-habits-clear-2018.yaml`)

詳細は `schema/book-entry.schema.json` を参照。

---

## セキュリティ

- `inbox/` の Raw Note は `.gitignore` 対象(公開リポジトリに含まれません)
- Takumi Guard (npm.flatt.tech) によるレジストリレベルの悪性パッケージブロック
- 全 GitHub Actions を commit SHA でピン留め
- MCP サーバーは stdio のみ、SQLite は読み取り専用

詳細は [SECURITY.md](SECURITY.md) を参照。

---

## ライセンス

- **Code** (`src/`, `mcp-server/`, `schema/`): [MIT License](LICENSE)
- **Content** (`books/`, `topics/`): [CC-BY-NC-4.0](LICENSE-content)