summaryrefslogtreecommitdiff
path: root/README.md
blob: 25a319df8d9de296527f21f9e6526d156c11436c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
# tiny-convmem-mcp

LLMの会話メッセージをローカルの追記ログへ保存する、Windows向けC17製MCP
サーバです。書込みと削除はディスクへの同期完了後に成功を返し、プロセス再起動時は
ログまたはsnapshotから状態を復旧します。

## 必要環境

- Windows x64
- Visual Studio Community 2026(Desktop development with C++)
- CMake 4.3以降
- Git
- vcpkg(PATHから実行可能であること)

## ビルドとテスト

```powershell
git submodule update --init --recursive
.\scripts\bootstrap.ps1 -Configuration Debug
```

手動実行する場合は次のとおりです。

```powershell
$config = vcpkg z-print-config | ConvertFrom-Json
$env:VCPKG_ROOT = $config.'vcpkg-root'
cmake --preset windows-vs2026
cmake --build --preset windows-vs2026-debug
ctest --preset windows-vs2026-debug
```

## 起動

保存先は必ず明示します。相対パスも使用できます。同じdata directoryを使用する
プロセスの二重起動は拒否されます。

```powershell
.\build\windows-vs2026\src\Debug\tiny-convmem-mcp.exe --data-dir .\data
```

stdoutはMCP JSON-RPC専用、stderrは診断専用です。

## MCP tools

- `write_message`: サーバ生成ULID・UTC timestamp付きメッセージを同期永続化
- `read_messages`: sessionの有効メッセージを時系列順に取得
- `search_messages`: contentとtagsをUTF-8コードポイントの2/3-gramで検索
- `delete_message`: DELレコードを同期永続化して即時不可視化
- `rebuild_index`: 有効PUTだけにcompactionしsnapshotを再生成
- `get_system_health`: ログ、snapshot、復旧状態、件数を報告

ツール結果はMCP TextContent内のJSON文字列です。入力schema、サイズ制限、エラーコード
および物理フォーマットは[architecture](docs/architecture.md)を参照してください。
実装済み・未実装・テスト状況の追跡表は
[implementation status](docs/implementation-status.md)にまとめています。

## 永続化と復旧

`active.log` はversion付きlittle-endianレコード、payload CRC32、単調sequenceを持ちます。
PUT/DELは `FlushFileBuffers` が成功するまで `OK` を返しません。末尾で中断したレコード
だけは正常境界まで自動切詰めし、途中のCRC不一致はデータを保存したまま起動を拒否します。

`rebuild_index` は新しいgeneration markerを持つログを作成後、同じgenerationとログoffsetを
記録した `snapshot.bin` を置換します。起動時に両者が一致するとsnapshotをロードし、後続
レコードだけを再生します。不一致または不正なsnapshotは変更せず、ログ全体を再生します。

削除は呼出時には論理削除です。元本文が `active.log` から除去されるのはcompaction成功時で、
SSD、バックアップ等からの安全消去は保証しません。`memory_tier` は初期版では属性であり、
自動要約・昇格・破棄を行いません。

## mcpcの管理

mcpc submoduleはコミット `4025fddfedcfa7573803a47236b147733fcb3c07` に固定しています。
固定版tool APIではoptional/object/array schemaとcallback contextを表現できないため、
プロジェクト側MCP互換境界がmcpc同梱のmjson parserを利用してraw argumentsとschemaを扱います。
submoduleのソースは変更しません。詳細は[src/mcp/README.md](src/mcp/README.md)を参照してください。

## コーディングスタイル

プロジェクト所有のCソースとヘッダーは、リポジトリ直下の
[`.clang-format`](.clang-format)に従います。制御文には常に波括弧を付け、1行には
1つのstatementだけを記述します。`third_party/` は整形対象外です。

Visual Studio同梱のclang-formatを使う場合は、PowerShellで次のように整形できます。

```powershell
$formatter = 'C:\Program Files\Microsoft Visual Studio\18\Community\VC\Tools\Llvm\bin\clang-format.exe'
$files = rg --files src tests -g '*.c' -g '*.h'
& $formatter -i --style=file $files
```