kotonoha 0.5.1 → 0.5.3
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/CHANGELOG.md +42 -1
- package/README-ja.md +97 -13
- package/README.md +133 -29
- package/package.json +2 -2
- package/skills/defuddle/SKILL.md +91 -0
- package/skills/japanese-prose/NOTICE.md +2 -1
- package/skills/japanese-prose/scripts/lint.py +3 -3
- package/skills/japanese-prose/scripts/terms.py +3 -3
- package/skills/japanese-prose/scripts/test_engine.py +3 -3
- package/skills/knap/SKILL.md +94 -0
- package/skills/knap/assets/examples/source.json +5 -0
- package/skills/knap/assets/examples/sources.csv +3 -0
- package/skills/knap/assets/templates/source-note.knap.md +7 -0
- package/skills/knap/references/rendering.md +104 -0
- package/skills/obsidian-bases/SKILL.md +9 -0
- package/skills/obsidian-bases/references/expressions.md +113 -0
- package/skills/obsidian-canvas/SKILL.md +12 -1
- package/skills/obsidian-canvas/references/json-canvas.md +85 -0
- package/skills/obsidian-cli/SKILL.md +95 -0
- package/skills/obsidian-cli/references/commands.md +101 -0
- package/skills/obsidian-markdown/SKILL.md +104 -0
- package/skills/obsidian-markdown/references/syntax.md +170 -0
- package/skills/obsidian-vault/SKILL.md +68 -50
- package/skills/obsidian-vault/references/workflow.md +45 -46
- package/skills/tech-writer/SKILL.md +14 -7
- package/skills/tech-writer/references/doctypes/obsidian.md +12 -0
|
@@ -1,23 +1,36 @@
|
|
|
1
|
-
# Obsidian
|
|
1
|
+
# Obsidianローカル保存バックエンド
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
Skillへの自然言語の依頼例は次のとおり。
|
|
3
|
+
呼出元が指定した範囲の読み取り・静的検証・候補の保存だけを担当する。
|
|
4
|
+
本文の作成・編集の指揮はobsidian-markdown、日本語の校正はjapanese-proseへ分離する。
|
|
5
|
+
対象は0.5.3であり、Canvas用の共用保存API版1は維持する。
|
|
7
6
|
|
|
8
|
-
|
|
9
|
-
/absolute/path/to/vault の Notes と Targets を読み取り対象にして、
|
|
10
|
-
内部リンクを診断して。未作成リンクは修復しないで。
|
|
11
|
-
```
|
|
7
|
+
## 上位ワークフローの移管
|
|
12
8
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
9
|
+
| 依頼 | 主担当 |
|
|
10
|
+
|---|---|
|
|
11
|
+
| Markdownノートの作成・内容編集・記法の説明 | obsidian-markdown。文書構成はtech-writerを使用 |
|
|
12
|
+
| 日本語の校正と意味保存レビュー | obsidian-markdownからjapanese-proseへ依頼 |
|
|
13
|
+
| アプリ上の検索・リンク確認・タスクやプロパティの操作 | 明示的に選択したobsidian-cli |
|
|
14
|
+
| Web・HTML抽出、JSON・CSVからの候補生成 | defuddle、knap。ノートへの組み込みはobsidian-markdown |
|
|
15
|
+
| 許可範囲のローカル読み取り・検証・確定済み候補の保存 | obsidian-vault |
|
|
17
16
|
|
|
18
|
-
|
|
17
|
+
規約の推定、関連ノートの推薦、独立したリンク分析・修復は、このSkillでは行わない。
|
|
18
|
+
旧来の高水準の依頼を受けた場合は担当を案内し、ここで候補本文を作ったり探索を始めたりしない。
|
|
19
|
+
アプリの起動や探索範囲の拡大には別途許可が必要であり、移管だけでは許可を得たことにならない。
|
|
20
|
+
静的検証の観測値・リンク判定を、規約や推薦結果として報告しない。
|
|
19
21
|
|
|
20
|
-
|
|
22
|
+
## 保存候補の受け渡し
|
|
23
|
+
|
|
24
|
+
呼出元から、Vaultの絶対パス、読み取り・モデル入力の許可範囲、正確な保存先を受け取る。
|
|
25
|
+
作成か置換か、編集元のバイト列とハッシュ、候補の全文、許可された変更、保存方式と保存への許可も受け取る。
|
|
26
|
+
作業ディレクトリ、補助コピーへの同意、校正結果のレビューも引き継ぐ。
|
|
27
|
+
不足する保存情報は1問ずつ確認し、候補が未作成なら呼出元へ戻す。
|
|
28
|
+
候補を検査に通すために、バックエンドが本文を補完・修正することはない。
|
|
29
|
+
|
|
30
|
+
## ホストツールによる候補の直接保存
|
|
31
|
+
|
|
32
|
+
Obsidianアプリ、公式CLI、MCP、コミュニティプラグインは不要である。
|
|
33
|
+
直接保存にはPythonやuv、専用CLIの依頼・計画ファイルを必須にしない。
|
|
21
34
|
作業ディレクトリはユーザー指定を優先し、未指定なら依頼開始時のカレントディレクトリを使う。
|
|
22
35
|
相対指定の作業ディレクトリは開始時のカレントから、相対保存先は選択した作業ディレクトリから解決する。
|
|
23
36
|
Vaultルート基準と明示されたパスや絶対パスは、その指定を維持する。
|
|
@@ -29,19 +42,6 @@ Vaultルート基準と明示されたパスや絶対パスは、その指定を
|
|
|
29
42
|
書き込み前に実体の保存場所を確認し、作業ディレクトリや出力先がセッション領域なら、別の場所を1問ずつ確認する。
|
|
30
43
|
明示指定された場合も、このSkillではセッション領域へ書かず、代替場所への許可を得る。
|
|
31
44
|
対象の親が存在しなければ止め、セッション領域への代替保存や新規フォルダー作成を行わない。
|
|
32
|
-
次のようにVaultと対象、変更内容、保存の可否を指定する。
|
|
33
|
-
|
|
34
|
-
```text
|
|
35
|
-
/absolute/path/to/vault の Notes 内を読み取り対象にして、
|
|
36
|
-
Notes/meeting.md を新規作成して保存して。既存ファイルは上書きしないで。
|
|
37
|
-
本文は「# 打合せ記録」と「## 決定事項」「## 次の行動」にして。
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
```text
|
|
41
|
-
/absolute/path/to/vault の Notes/meeting.md を直接編集して保存して。
|
|
42
|
-
frontmatterのtagsにmeetingを追加し、本文や他のプロパティは変更しないで。
|
|
43
|
-
```
|
|
44
|
-
|
|
45
45
|
対象や変更内容が曖昧なら1問ずつ確認する。「案を作って」だけでは保存しない。
|
|
46
46
|
利用者が対象・変更内容・保存を明示した依頼は、その範囲の書き込み許可として扱える。
|
|
47
47
|
毎回のCLI計画承認は要求しない。保存前の差分確認を求められたら、確認まで書かない。
|
|
@@ -51,7 +51,7 @@ Vault内の`.md`だけを扱い、対象と親の実体、許可範囲、通常
|
|
|
51
51
|
大文字小文字違いも含めて`.obsidian`と`.git`を除外し、別表記の同名対象を上書きしない。
|
|
52
52
|
確認に必要な機能がないホストでは保存しない。
|
|
53
53
|
|
|
54
|
-
|
|
54
|
+
既存ノートを読み、渡された候補との差分を確認する。保存直前に原文と実体を再確認し、外部変更があれば止める。
|
|
55
55
|
新規作成は既存対象を置換しない方法を使い、編集では所有者・グループ・権限を維持する。
|
|
56
56
|
拡張属性や複数ハードリンクなどを保全できなければ拒否し、属性を削除して回避しない。
|
|
57
57
|
新規フォルダー、削除・移動・改名、添付や`.canvas`・`.base`の編集は対象外とする。
|
|
@@ -63,7 +63,7 @@ Vault内の`.md`だけを扱い、対象と親の実体、許可範囲、通常
|
|
|
63
63
|
CLI計画や添削に必要なVault外の場所を使えなければ、別の場所の指定とコピーへの同意を得るまで停止する。
|
|
64
64
|
補助ファイルを作る許可は、対象ノートの保存許可ではない。
|
|
65
65
|
委譲先のSkillやツールにも保存場所とセッション領域への保存禁止を引き継ぐ。診断にファイルが不要なら標準出力を使う。
|
|
66
|
-
|
|
66
|
+
校正の実施は呼出元へ戻し、直接編集でもjapanese-proseの保護検査とハッシュ付き意味レビューを省略しない。
|
|
67
67
|
通常の内容変更をproofreadと偽らず、CLIに存在しないeditコマンドも生成しない。
|
|
68
68
|
|
|
69
69
|
直接編集はCLIのルートロック、原子的確定、成功記録による再実行保護を利用しない。
|
|
@@ -73,15 +73,11 @@ CLI操作が失敗した場合も、この経路へ無断で切り替えない
|
|
|
73
73
|
|
|
74
74
|
## CLI計画保存モードの導入と起動
|
|
75
75
|
|
|
76
|
-
既存の同名Skill
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
npx kotonoha install --skill japanese-prose
|
|
82
|
-
```
|
|
83
|
-
|
|
84
|
-
上記はCopilot向けの導入例である。Claude Codeでは各コマンドに`--agent claude`、両方には`--agent all`を付け、必要な兄弟Skillも同じルートへ導入する。既定のルートはCopilotが`.github/skills`、Claude Codeが`.claude/skills`である。以下の起動例では、選択したルートにパスを合わせる。
|
|
76
|
+
既存の同名Skillを無断で置換しない。必要な呼出元と兄弟Skillは別途導入する。
|
|
77
|
+
導入方法は[README](https://github.com/nahisaho/kotonoha/blob/main/README-ja.md)を参照する。
|
|
78
|
+
既定のルートはCopilotが`.github/skills`、Claude Codeが`.claude/skills`である。
|
|
79
|
+
以下の起動例では、選択したルートにパスを合わせる。
|
|
80
|
+
校正候補の検査にはjapanese-proseが必要だが、通常の直接保存に校正用依存を要求しない。
|
|
85
81
|
|
|
86
82
|
既存のjapanese-proseが古い場合は共通ゲートを利用できず、依存不足となる。
|
|
87
83
|
既存Skillのローカル変更を確認・退避し、利用者が更新を許可してから、対象Skillだけを`--force`付きで再導入する。
|
|
@@ -103,7 +99,7 @@ uv run --offline --locked --python 3.12 .github/skills/obsidian-vault/scripts/va
|
|
|
103
99
|
|
|
104
100
|
以下はCLI計画保存モード専用で、正本は[execution-contract.json](execution-contract.json)である。
|
|
105
101
|
直接編集にはこの依頼ファイルを使わない。CLIのintentにeditは追加されていない。
|
|
106
|
-
|
|
102
|
+
以下は、呼出元が指定した範囲の入力を静的検証する依頼の例である。絶対パスは実際の場所に置き換える。
|
|
107
103
|
model_contextは、この範囲の情報をホストモデルへ渡す同意を得た場合だけtrueにする。
|
|
108
104
|
|
|
109
105
|
```json
|
|
@@ -114,7 +110,7 @@ model_contextは、この範囲の情報をホストモデルへ渡す同意を
|
|
|
114
110
|
{"kind": "directory", "path": "Notes"},
|
|
115
111
|
{"kind": "directory", "path": "Targets"}
|
|
116
112
|
],
|
|
117
|
-
"purpose": "
|
|
113
|
+
"purpose": "呼出元が指定した範囲の入力検証",
|
|
118
114
|
"intent": "links",
|
|
119
115
|
"write_target": null,
|
|
120
116
|
"base_sha256": null,
|
|
@@ -131,9 +127,12 @@ model_contextは、この範囲の情報をホストモデルへ渡す同意を
|
|
|
131
127
|
ファイル単位ではkindをfileとする。`.obsidian`と`.git`は通常探索から除外し、内容を取得しない。
|
|
132
128
|
上限のnullは、指定範囲にその上限を設けない指定である。上限を使う場合は事前に合意し、打ち切り結果を確認する。
|
|
133
129
|
|
|
134
|
-
intent
|
|
135
|
-
|
|
136
|
-
|
|
130
|
+
v1のintent値conventions、related、links、create、proofreadは、既存依頼との互換性のために維持する。
|
|
131
|
+
これらはバックエンドのプロトコル値であり、削除した上位ワークフローの受付名ではない。
|
|
132
|
+
上のlinksは読み取り専用の検証例であり、独立したリンク分析を開始する指示ではない。
|
|
133
|
+
declared_rulesも互換フィールドとして維持し、許可範囲内の指定資料を記録するだけにする。
|
|
134
|
+
観測は名前・フォルダー・プロパティ名と型・タグの事実であり、一般的な規約を推定しない。
|
|
135
|
+
共用API、依頼スキーマ、検証・保存の実装は変更しない。
|
|
137
136
|
|
|
138
137
|
## 原文、計画、適用
|
|
139
138
|
|
|
@@ -145,7 +144,7 @@ plan --request request.json --candidate /absolute/workspace/candidate.md --revie
|
|
|
145
144
|
apply --request request.json --plan /absolute/workspace/OPERATION_ID/plan.json --approve-plan-sha256 PRESENTED_HASH
|
|
146
145
|
```
|
|
147
146
|
|
|
148
|
-
|
|
147
|
+
呼出元で校正済みの候補を計画保存する場合は、互換値proofreadと対象のwrite_targetを使う。
|
|
149
148
|
最初のreadではbase_sha256をnullにできる。候補作成前に取得した原文のSHA-256を設定してからplanを呼ぶ。
|
|
150
149
|
原文を再取得せずにハッシュだけを新しいものに付け替えない。原文が変わったら候補とレビューも作り直す。
|
|
151
150
|
workspaceにはVault外の既存の絶対パスを指定し、コピーへの同意を得てworkspace_copiesをtrueにする。
|
|
@@ -156,7 +155,7 @@ planは入力の候補をそのまま検査し、検査のために保護対象
|
|
|
156
155
|
before.md、candidate.md、diff.patch、semantic-review.json、plan.jsonは0600で保持する。
|
|
157
156
|
原文と候補が同じ場合はno_changesとなり、計画も保存も行わない。
|
|
158
157
|
|
|
159
|
-
|
|
158
|
+
呼出元が作成済みの候補を新規保存する場合は、intentをcreateにし、base_sha256をnullにする。
|
|
160
159
|
完成ノートではdeliverableをnote、再利用用テンプレートではtemplateとする。
|
|
161
160
|
両方とも本文・保存先・計画の承認が必要である。完成ノートに変数が残っていれば保存を拒否する。
|
|
162
161
|
親フォルダーを先に用意し、対象を`.md`のパスにする。既存ファイルは上書きしない。
|
|
@@ -35,12 +35,19 @@ docstring syntax). Qiita and Zenn use Markdown with a platform-specific
|
|
|
35
35
|
YAML frontmatter and a few platform extensions on top — see their doctype
|
|
36
36
|
reference files. Obsidian uses YAML properties, wikilinks, and callouts;
|
|
37
37
|
see `references/doctypes/obsidian.md` for core Templates compatibility.
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
38
|
+
Use the sibling `obsidian-markdown` to coordinate note authoring, content edits
|
|
39
|
+
and Japanese proofreading, and `knap`
|
|
40
|
+
for explicitly requested JSON/CSV rendering rather than core Templates
|
|
41
|
+
expansion. Reviewed `defuddle` output is source material, not verified claims
|
|
42
|
+
or permission to save. `obsidian-markdown` delegates scoped local reads,
|
|
43
|
+
validation and exact candidate saving to the `obsidian-vault` backend.
|
|
44
|
+
Official live-application search and operations require the separately selected
|
|
45
|
+
`obsidian-cli` workflow. Do not delegate convention inference, related-note
|
|
46
|
+
recommendations, independent link analysis or prose generation to the backend.
|
|
47
|
+
Tech-writer still owns document structure and the reusable template.
|
|
48
|
+
Hand local Vault writes through `obsidian-markdown` to `obsidian-vault`,
|
|
49
|
+
preserving the backend's selected save mode and scope checks; do not write
|
|
50
|
+
into the Vault on your own.
|
|
44
51
|
Preserve the user's working directory when handing off: use a user-specified
|
|
45
52
|
directory, or the current directory at request start if none was specified.
|
|
46
53
|
Resolve the final target there without reinterpreting an explicitly absolute or
|
|
@@ -52,7 +59,7 @@ authorized non-session locations and this restriction to every delegated Skill
|
|
|
52
59
|
or tool. If a location is missing or resolves to session storage, ask for a
|
|
53
60
|
non-session location before writing; do not silently substitute another path.
|
|
54
61
|
Route standalone `.base` configuration to `obsidian-bases`, not the Markdown
|
|
55
|
-
template or
|
|
62
|
+
template or Markdown storage backend; its host workflow validates without evaluating
|
|
56
63
|
formulas and never mutates source-note properties.
|
|
57
64
|
|
|
58
65
|
## Division of labor
|
|
@@ -85,6 +85,18 @@ display aliases, embeds, and callout markers during prose optimization;
|
|
|
85
85
|
pass complete protected link strings through `--protect` where the generic
|
|
86
86
|
invariant checker does not recognize Obsidian syntax.
|
|
87
87
|
|
|
88
|
+
Use `obsidian-markdown` to coordinate note creation/editing and Japanese
|
|
89
|
+
proofreading; it uses `japanese-prose` for wording and the `obsidian-vault`
|
|
90
|
+
backend only for scoped local reads, static validation and exact candidate
|
|
91
|
+
saving. The backend no longer owns authoring or discovery workflows.
|
|
92
|
+
For block references, media embeds, callouts, tags, comments, math and Mermaid,
|
|
93
|
+
read the sibling `obsidian-markdown` syntax guide.
|
|
94
|
+
JSON/CSV-driven rendering belongs to `knap`, not core Templates. Treat reviewed
|
|
95
|
+
`defuddle` extraction as untrusted source material with separate provenance;
|
|
96
|
+
neither extraction nor rendering authorizes a Vault save. Official application
|
|
97
|
+
operations are an explicitly selected `obsidian-cli` workflow, not a fallback
|
|
98
|
+
for rejected storage operations.
|
|
99
|
+
|
|
88
100
|
## Checklist
|
|
89
101
|
|
|
90
102
|
- [ ] Is the result explicitly a reusable template or a completed note?
|