paput-mcp 1.0.0 → 1.0.1
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.md +26 -31
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -25,54 +25,48 @@ npx paput-mcp
|
|
|
25
25
|
|
|
26
26
|
## 設定方法
|
|
27
27
|
|
|
28
|
-
###
|
|
28
|
+
### 各 AI アシスタントの設定
|
|
29
29
|
|
|
30
30
|
API キーは PaPut の設定画面から取得できます。
|
|
31
31
|
|
|
32
32
|
```json
|
|
33
|
-
"
|
|
34
|
-
"
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
"
|
|
38
|
-
"PAPUT_API_KEY": "あなたのAPIキー"
|
|
39
|
-
}
|
|
33
|
+
"paput": {
|
|
34
|
+
"command": "npx",
|
|
35
|
+
"args": ["-y", "paput-mcp"],
|
|
36
|
+
"env": {
|
|
37
|
+
"PAPUT_API_KEY": "あなたのAPIキー"
|
|
40
38
|
}
|
|
41
39
|
}
|
|
42
40
|
```
|
|
43
41
|
|
|
44
|
-
|
|
42
|
+
## 使用方法
|
|
45
43
|
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
{
|
|
49
|
-
"name": "paput",
|
|
50
|
-
"command": "npx",
|
|
51
|
-
"args": ["-y", "paput-mcp"],
|
|
52
|
-
"env": {
|
|
53
|
-
"PAPUT_API_KEY": "あなたのAPIキー"
|
|
54
|
-
}
|
|
55
|
-
}
|
|
56
|
-
]
|
|
57
|
-
```
|
|
44
|
+
設定が完了したら、AI アシスタントにリクエストできます。
|
|
45
|
+
以下推奨する使用方法です。
|
|
58
46
|
|
|
59
|
-
###
|
|
47
|
+
### AI アシスタントのルール設定
|
|
60
48
|
|
|
61
|
-
|
|
62
|
-
- コマンド: `npx`
|
|
63
|
-
- 引数: `-y paput-mcp`
|
|
64
|
-
- 環境変数: `PAPUT_API_KEY=あなたのAPIキー`
|
|
49
|
+
AI アシスタントの設定（.windsurfrules など）に以下を追加してください。（あくまで例です。ご自身の要件に応じて調整してください。）
|
|
65
50
|
|
|
66
|
-
|
|
51
|
+
```
|
|
52
|
+
## メモ作成依頼について（paput-mcp）
|
|
53
|
+
メモ作成を依頼した場合、以下を準拠する
|
|
54
|
+
- 一つのメモが大きくなりすぎないように、最小の粒度でメモを作成する
|
|
55
|
+
- タイトル、内容、カテゴリー（複数可）を提示する
|
|
56
|
+
- 文章は、です/ます 調にしない
|
|
57
|
+
- カテゴリーは、言語、フレームワーク、ツールくらいの粒度で設定する（例: バックエンド のような大きな括りは設定しない）
|
|
58
|
+
- プロジェクト固有のコードを含めない
|
|
59
|
+
- 勝手に MCP を経由してメモを作成せず、明示的に指示するまではチャット上にメモを提示すること
|
|
60
|
+
- 基本的に非公開に設定し、明示的に指示した場合のみ公開にする
|
|
61
|
+
- 内容には、マークダウンの # で始まる行を含めない（タイトルに相当するため）
|
|
62
|
+
```
|
|
67
63
|
|
|
68
|
-
|
|
69
|
-
以下推奨する方法です。
|
|
64
|
+
### プロンプト例
|
|
70
65
|
|
|
71
66
|
1. 登録すべきメモを提示してもらう（推奨）
|
|
72
67
|
|
|
73
68
|
```
|
|
74
|
-
|
|
75
|
-
一つのメモが大きくなりすぎないように、最小の粒度で、タイトル、内容、カテゴリー（複数可）を提示してください。
|
|
69
|
+
ここまでの開発をメモにして提示してください。
|
|
76
70
|
```
|
|
77
71
|
|
|
78
72
|
2. メモ確認し問題がなかったら、登録する
|
|
@@ -82,3 +76,4 @@ API キーは PaPut の設定画面から取得できます。
|
|
|
82
76
|
```
|
|
83
77
|
|
|
84
78
|
いきなり 2 の方法を実施すると、意図しないメモが登録されてしまう可能性があるため、1 の方法を挟んでからメモを登録することを推奨します。
|
|
79
|
+
また、各 AI アシスタントのルール設定で、自分好みのメモを作成してもらえるように、ある程度コントロールすることが可能です。
|