Add quickstart guide and MCP test script
This commit is contained in:
Claude
266
QUICKSTART.md
Normal file
266
QUICKSTART.md
Normal file
@@ -0,0 +1,266 @@
|
||||
# クイックスタートガイド 🚀
|
||||
|
||||
## 今すぐ試す方法
|
||||
|
||||
### ステップ1: MCPサーバーを起動
|
||||
|
||||
```bash
|
||||
# 基本版（AI機能なし）
|
||||
./target/debug/aigpt server
|
||||
|
||||
# AI機能有効版（OpenAI APIキーが必要）
|
||||
OPENAI_API_KEY=your_key ./target/debug/aigpt server
|
||||
```
|
||||
|
||||
### ステップ2: Claude Desktop/Codeに設定
|
||||
|
||||
#### Claude Codeの場合
|
||||
```bash
|
||||
# MCP設定に追加
|
||||
claude mcp add aigpt /home/user/aigpt/target/debug/aigpt server
|
||||
```
|
||||
|
||||
#### 手動設定の場合
|
||||
`~/.config/claude-code/config.json` に追加：
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"aigpt": {
|
||||
"command": "/home/user/aigpt/target/debug/aigpt",
|
||||
"args": ["server"]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### ステップ3: Claude Codeを再起動
|
||||
|
||||
MCPサーバーを認識させるため、Claude Codeを再起動してください。
|
||||
|
||||
---
|
||||
|
||||
## 使い方の流れ
|
||||
|
||||
### 🎮 1. 心理テスト風にメモリ作成
|
||||
|
||||
**Claude Codeで:**
|
||||
```
|
||||
create_memory_with_ai ツールを使って
|
||||
「今日、新しいAIシステムのアイデアを思いついた」
|
||||
というメモリを作成してください。
|
||||
```
|
||||
|
||||
**結果:**
|
||||
```
|
||||
╔══════════════════════════════════════╗
|
||||
║ 🎲 メモリースコア判定 ║
|
||||
╚══════════════════════════════════════╝
|
||||
|
||||
🟣 EPIC 85点
|
||||
💡 【革新者】
|
||||
|
||||
💕 好感度: ❤️❤️🤍🤍🤍🤍🤍🤍🤍🤍
|
||||
💎 XP獲得: +850 XP
|
||||
|
||||
📤 シェア用テキストも生成されます！
|
||||
```
|
||||
|
||||
### 💕 2. 恋愛コンパニオンを作成
|
||||
|
||||
**Claude Codeで:**
|
||||
```
|
||||
create_companion ツールで、
|
||||
名前「エミリー」、性格「energetic」の
|
||||
コンパニオンを作成してください。
|
||||
```
|
||||
|
||||
**結果:**
|
||||
```
|
||||
╔══════════════════════════════════════╗
|
||||
║ 💕 エミリー のプロフィール ║
|
||||
╚══════════════════════════════════════╝
|
||||
|
||||
⚡ 性格: 元気で冒険好き
|
||||
|
||||
🏆 関係レベル: Lv.1
|
||||
💕 好感度: 🤍🤍🤍🤍🤍🤍🤍🤍🤍🤍 0%
|
||||
|
||||
💬 今日のひとこと:
|
||||
「おはよう！今日は何か面白いことある？」
|
||||
```
|
||||
|
||||
### 🎊 3. コンパニオンに反応してもらう
|
||||
|
||||
**Claude Codeで:**
|
||||
```
|
||||
companion_react ツールで、
|
||||
先ほど作成した記憶IDを渡してください。
|
||||
```
|
||||
|
||||
**結果:**
|
||||
```
|
||||
╔══════════════════════════════════════╗
|
||||
║ 💕 エミリー の反応 ║
|
||||
╚══════════════════════════════════════╝
|
||||
|
||||
⚡ エミリー:
|
||||
「すごい！新しいAIシステムのアイデア
|
||||
って本当に素晴らしいね！
|
||||
一緒に実現させよう！」
|
||||
|
||||
💕 好感度: ❤️❤️🤍🤍🤍🤍🤍🤍🤍🤍 15%
|
||||
💎 XP獲得: +850 XP
|
||||
```
|
||||
|
||||
### 🏆 4. ランキング確認
|
||||
|
||||
**Claude Codeで:**
|
||||
```
|
||||
list_memories_by_priority ツールで
|
||||
TOP 10を表示してください。
|
||||
```
|
||||
|
||||
**結果:**
|
||||
```
|
||||
╔══════════════════════════════════════╗
|
||||
║ 🏆 メモリーランキング TOP 10 ║
|
||||
╚══════════════════════════════════════╝
|
||||
|
||||
🥇 1位 🟣 EPIC 85点 - 新しいAIシステム...
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 現在の制限事項と対処法
|
||||
|
||||
### ❌ AI機能が使えない場合
|
||||
|
||||
**原因:** OpenAI APIキーが未設定
|
||||
|
||||
**対処法:**
|
||||
```bash
|
||||
# 環境変数に設定
|
||||
export OPENAI_API_KEY=sk-...
|
||||
|
||||
# または起動時に指定
|
||||
OPENAI_API_KEY=sk-... ./target/debug/aigpt server
|
||||
```
|
||||
|
||||
**代替案:**
|
||||
```
|
||||
# 基本版のツールを使う（AI機能なし）
|
||||
create_memory ツールで「テスト」というメモリを作成
|
||||
|
||||
# スコアは固定で 0.5 になります
|
||||
```
|
||||
|
||||
### ❌ コンパニオンが保存されない
|
||||
|
||||
**現状:** セッション終了で消える
|
||||
|
||||
**対処法（今後実装予定）:**
|
||||
- JSON保存機能
|
||||
- 次回起動時に自動ロード
|
||||
|
||||
**今できること:**
|
||||
- 毎回 create_companion で再作成
|
||||
- プロフィールをスクリーンショット保存
|
||||
|
||||
---
|
||||
|
||||
## トラブルシューティング
|
||||
|
||||
### Q: MCPツールが見つからない
|
||||
```bash
|
||||
# Claude Codeを完全再起動
|
||||
# または設定ファイルを確認
|
||||
cat ~/.config/claude-code/config.json
|
||||
```
|
||||
|
||||
### Q: 記憶が保存されない
|
||||
```bash
|
||||
# データファイルを確認
|
||||
ls -la ~/.config/syui/ai/gpt/memory.json
|
||||
|
||||
# ない場合は自動作成されます
|
||||
```
|
||||
|
||||
### Q: ビルドエラーが出る
|
||||
```bash
|
||||
# 依存関係を更新
|
||||
cargo clean
|
||||
cargo build --release
|
||||
|
||||
# AI機能付き
|
||||
cargo build --release --features ai-analysis
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## おすすめの使い方
|
||||
|
||||
### 💡 アイデア記録として
|
||||
1. 思いついたアイデアを create_memory_with_ai で記録
|
||||
2. スコアで重要度を客観的に判定
|
||||
3. 高スコアのアイデアに集中
|
||||
|
||||
### 💕 恋愛ゲームとして
|
||||
1. コンパニオンを作成
|
||||
2. 日々の出来事や考えを記録
|
||||
3. コンパニオンに反応してもらう
|
||||
4. 好感度MAXを目指す
|
||||
|
||||
### 📊 自己分析として
|
||||
1. 定期的に思考を記録
|
||||
2. 診断タイプの傾向を確認
|
||||
3. ランキングで振り返り
|
||||
|
||||
---
|
||||
|
||||
## 次にやること
|
||||
|
||||
### すぐできる改善
|
||||
- [ ] コンパニオンの永続化実装
|
||||
- [ ] 複数コンパニオン対応
|
||||
- [ ] デイリーチャレンジ完了チェック
|
||||
|
||||
### 中期的な目標
|
||||
- [ ] Bluesky連携（シェア機能）
|
||||
- [ ] Webダッシュボード
|
||||
- [ ] もっと多様なイベント
|
||||
|
||||
---
|
||||
|
||||
## 楽しみ方のコツ
|
||||
|
||||
1. **毎日使う**
|
||||
- daily_challenge で習慣化
|
||||
- コンパニオンの「今日のひとこと」
|
||||
|
||||
2. **高スコアを狙う**
|
||||
- LEGENDARY (90%+) を目指す
|
||||
- XP 1000獲得の快感
|
||||
|
||||
3. **相性を楽しむ**
|
||||
- 自分のタイプを確認
|
||||
- 相性の良いコンパニオン選択
|
||||
|
||||
4. **イベントを楽しむ**
|
||||
- 好感度100%の告白イベント
|
||||
- レベル10の特別な絆
|
||||
|
||||
---
|
||||
|
||||
## さあ、始めよう！ 🚀
|
||||
|
||||
```bash
|
||||
# MCPサーバー起動
|
||||
./target/debug/aigpt server
|
||||
|
||||
# Claude Codeで試す
|
||||
# → create_memory_with_ai
|
||||
# → create_companion
|
||||
# → companion_react
|
||||
# → 楽しむ！
|
||||
```
|
||||
47
test-mcp.sh
Executable file
47
test-mcp.sh
Executable file
@@ -0,0 +1,47 @@
|
||||
#!/bin/bash
|
||||
|
||||
echo "🧪 MCPサーバーテスト開始..."
|
||||
echo ""
|
||||
|
||||
# サーバー起動（バックグラウンド）
|
||||
./target/debug/aigpt server &
|
||||
SERVER_PID=$!
|
||||
|
||||
sleep 2
|
||||
|
||||
echo "✅ サーバー起動完了 (PID: $SERVER_PID)"
|
||||
echo ""
|
||||
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━"
|
||||
echo "📋 利用可能なツール一覧:"
|
||||
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━"
|
||||
echo ""
|
||||
echo "基本ツール:"
|
||||
echo " • create_memory"
|
||||
echo " • search_memories"
|
||||
echo " • update_memory"
|
||||
echo " • delete_memory"
|
||||
echo ""
|
||||
echo "AI機能ツール 🎮:"
|
||||
echo " • create_memory_with_ai (心理テスト風)"
|
||||
echo " • list_memories_by_priority (ランキング)"
|
||||
echo " • daily_challenge (デイリークエスト)"
|
||||
echo ""
|
||||
echo "恋愛コンパニオン 💕:"
|
||||
echo " • create_companion"
|
||||
echo " • companion_react"
|
||||
echo " • companion_profile"
|
||||
echo ""
|
||||
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━"
|
||||
echo ""
|
||||
echo "🎯 次のステップ:"
|
||||
echo "1. Claude Codeの設定に追加"
|
||||
echo "2. Claude Code再起動"
|
||||
echo "3. ツールを使って試す！"
|
||||
echo ""
|
||||
echo "設定ファイル: ~/.config/claude-code/config.json"
|
||||
echo ""
|
||||
|
||||
# サーバー停止
|
||||
kill $SERVER_PID 2>/dev/null
|
||||
|
||||
echo "✅ テスト完了！"
|
||||
Reference in New Issue
Block a user