proofscan 0.4.1 → 0.4.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.ja.md +167 -0
- package/README.md +2 -0
- package/package.json +1 -1
package/README.ja.md
ADDED
|
@@ -0,0 +1,167 @@
|
|
|
1
|
+
# ProofScan（日本語）
|
|
2
|
+
|
|
3
|
+
> **Languages:** [English](README.md) | 日本語
|
|
4
|
+
|
|
5
|
+
MCPサーバースキャナー - JSON-RPC通信を記録し、ブラックボックスを可視化します。
|
|
6
|
+
|
|
7
|
+
## 概要
|
|
8
|
+
|
|
9
|
+
proofscanは、MCP（Model Context Protocol）サーバーとの通信を可視化するツールです。
|
|
10
|
+
|
|
11
|
+
- MCPサーバーへのstdio接続を確立
|
|
12
|
+
- すべてのJSON-RPCメッセージ（リクエスト、レスポンス、通知）を記録
|
|
13
|
+
- SQLiteに保存し、効率的なクエリと分析が可能
|
|
14
|
+
- mcp.so / Claude Desktop形式からの設定インポートに対応
|
|
15
|
+
- 直感的なCLIコマンドでデータを確認・探索
|
|
16
|
+
|
|
17
|
+
## インストール
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
npm install -g proofscan
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
またはインストールせずに実行：
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
npx proofscan --help
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## クイックスタート
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
# 1. 設定を初期化
|
|
33
|
+
pfscan config init
|
|
34
|
+
|
|
35
|
+
# 2. MCPサーバーをインポート
|
|
36
|
+
echo '{"mcpServers":{"time":{"command":"uvx","args":["mcp-server-time"]}}}' \
|
|
37
|
+
| pfscan connectors import --from mcpServers --stdin
|
|
38
|
+
|
|
39
|
+
# 3. スキャンして確認
|
|
40
|
+
pfscan scan start --id time # スキャン実行
|
|
41
|
+
pfscan # 最近のイベントを表示
|
|
42
|
+
pfscan tree # 構造を表示
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## Phase 3 コンセプト
|
|
46
|
+
|
|
47
|
+
### 設計思想：すべてを残す → 意味のあるものを残す
|
|
48
|
+
|
|
49
|
+
Phase 3では、「すべてのJSON-RPCを記録する」から「セキュリティ上意味のあるものを効率的に残す」へと進化します。
|
|
50
|
+
|
|
51
|
+
### 用語定義
|
|
52
|
+
|
|
53
|
+
| 日本語 | 英語 | 意味 |
|
|
54
|
+
|--------|------|------|
|
|
55
|
+
| **できること** | capability | サーバーが提供する機能（tools/list で取得） |
|
|
56
|
+
| **やったこと** | tool call | 実際に実行されたツール呼び出し（tools/call） |
|
|
57
|
+
|
|
58
|
+
### 操作カテゴリ
|
|
59
|
+
|
|
60
|
+
ツールの操作は以下のカテゴリに分類されます：
|
|
61
|
+
|
|
62
|
+
- **読み取り** - ファイルやデータの読み込み
|
|
63
|
+
- **書き込み** - ファイルやデータの変更
|
|
64
|
+
- **ネット接続** - 外部ネットワークへのアクセス
|
|
65
|
+
- **コマンド実行** - シェルコマンドの実行
|
|
66
|
+
- **その他操作** - 上記以外の操作
|
|
67
|
+
|
|
68
|
+
### CLIコマンド
|
|
69
|
+
|
|
70
|
+
#### pfscan summary
|
|
71
|
+
|
|
72
|
+
サマリー表示。**注意点**（セキュリティ上の懸念）も含めて表示します。
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
$ pfscan summary --session abc123
|
|
76
|
+
|
|
77
|
+
time (1 session)
|
|
78
|
+
├── できること: read_file, write_file, execute_command
|
|
79
|
+
├── やったこと: read_file (3回), write_file (1回)
|
|
80
|
+
└── 注意点: コマンド実行可能、書き込み操作あり
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
#### pfscan permissions
|
|
84
|
+
|
|
85
|
+
詳細なパーミッション情報を表示します。**注意点は表示しません**（詳細確認用のため）。
|
|
86
|
+
|
|
87
|
+
```bash
|
|
88
|
+
$ pfscan permissions --session abc123
|
|
89
|
+
|
|
90
|
+
time
|
|
91
|
+
├── 読み取り: read_file
|
|
92
|
+
├── 書き込み: write_file
|
|
93
|
+
├── コマンド実行: execute_command
|
|
94
|
+
└── その他操作: (なし)
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
### record dry-run
|
|
98
|
+
|
|
99
|
+
スキャン候補の記録をプレビューします。
|
|
100
|
+
|
|
101
|
+
```bash
|
|
102
|
+
# デフォルト: tools/call のみ候補化
|
|
103
|
+
$ pfscan record dry-run --session abc123
|
|
104
|
+
|
|
105
|
+
記録候補:
|
|
106
|
+
[1] tools/call: read_file (2025-12-28 12:00:00)
|
|
107
|
+
[2] tools/call: write_file (2025-12-28 12:00:05)
|
|
108
|
+
|
|
109
|
+
# --include-capabilities: tools/list も候補に追加
|
|
110
|
+
$ pfscan record dry-run --session abc123 --include-capabilities
|
|
111
|
+
|
|
112
|
+
記録候補:
|
|
113
|
+
[0] tools/list (2025-12-28 11:59:55) ← 1回のみ
|
|
114
|
+
[1] tools/call: read_file (2025-12-28 12:00:00)
|
|
115
|
+
[2] tools/call: write_file (2025-12-28 12:00:05)
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
### セキュリティデフォルト
|
|
119
|
+
|
|
120
|
+
安全を優先した設計：
|
|
121
|
+
|
|
122
|
+
| 設定 | デフォルト | 説明 |
|
|
123
|
+
|------|-----------|------|
|
|
124
|
+
| input/output | `digest_only` | 生データではなくハッシュのみ保存 |
|
|
125
|
+
| canonicalize | `sha256` | 正規化後にSHA-256ハッシュ化 |
|
|
126
|
+
|
|
127
|
+
これにより、機密データの漏洩リスクを最小化しながら、操作の証跡を残すことができます。
|
|
128
|
+
|
|
129
|
+
## 主要コマンド
|
|
130
|
+
|
|
131
|
+
```
|
|
132
|
+
共通コマンド:
|
|
133
|
+
view, v 最近のイベントタイムラインを表示（デフォルト）
|
|
134
|
+
tree, t connector → session → rpc の構造を表示
|
|
135
|
+
explore, e インタラクティブなデータブラウザ
|
|
136
|
+
scan, s 新しいスキャンを実行
|
|
137
|
+
status, st システム状態を表示
|
|
138
|
+
rpc RPC呼び出しの詳細を表示
|
|
139
|
+
|
|
140
|
+
管理:
|
|
141
|
+
archive, a 古いデータのアーカイブと削除
|
|
142
|
+
config, c 設定管理
|
|
143
|
+
connectors コネクタ管理
|
|
144
|
+
|
|
145
|
+
ショートカット:
|
|
146
|
+
v=view t=tree e=explore s=scan st=status a=archive c=config
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
## 設定ファイルの場所
|
|
150
|
+
|
|
151
|
+
OSごとの標準的な場所に保存されます：
|
|
152
|
+
|
|
153
|
+
- **Windows**: `%APPDATA%\proofscan\config.json`
|
|
154
|
+
- **macOS**: `~/Library/Application Support/proofscan/config.json`
|
|
155
|
+
- **Linux**: `~/.config/proofscan/config.json`
|
|
156
|
+
|
|
157
|
+
## グローバルオプション
|
|
158
|
+
|
|
159
|
+
```
|
|
160
|
+
-c, --config <path> 設定ファイルのパス
|
|
161
|
+
--json JSON形式で出力
|
|
162
|
+
-v, --verbose 詳細出力
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
## ライセンス
|
|
166
|
+
|
|
167
|
+
MIT
|
package/README.md
CHANGED