playfab-mcp-server: Instructions file for Claude Code

PlayFab MCP サーバープロジェクトガイドライン

重要なルール

• 日本語で回答する
• エコノミーAPIはv2のみを利用する - レガシーv1 APIは使用しない
• ソースコード修正後は必ずビルドしてdistを更新する - npm run buildを実行
• ルールの追加は必ずCLAUDE.mdに追記する
• CHANGELOG.mdは英語で記載する
• PlayFab REST APIの追加・修正時には必ず公式サイトでパラメーターの整合性を取ること - https://learn.microsoft.com/ja-jp/rest/api/playfab/?view=playfab-rest
• markdownlintの警告を全て修正する - 見出しの前後に空行、コードブロックの言語指定、ファイル末尾改行など
• 一覧のタスクが完了したら、コミットログを自動生成してコミットを行う
• コミットログはcommitlint形式で生成する - type(scope): description の形式
• コミットログは日本語 - コミットメッセージの説明部分は日本語で記載
• コミットの際には、必ず承認を取ること - ユーザーの明示的な許可なしにコミットしない
• パッケージが足りない場合はインストールを行う - 必要な依存関係を自動的にインストール
• モデルは /model opus を優先的に利用するが、レートリミットがかかった場合 /model sonnet で自動的に切り替える
• Spec Kit（日本語対応版）を必ず使用し、仕様→計画→タスク→実装の順に進める - /speckit.* コマンドや .specify/scripts/bash/*.sh を利用
• ブランチ自動作成は禁止（Worktree設計） - スクリプトのデフォルトもブランチを作らない; 必要なら明示的に --branch
• できる限り熟考して解決する - 複雑な問題や改善提案には深い思考と包括的な分析を行う
• 割り込みで別の処理をした後は、必ず残っているタスクの続きを実行する
• ビルドエラーは必ず排除する - TypeScriptコンパイルエラーを放置しない
• 何か更新された場合は、関連するドキュメントを必ず更新する
• 作業内容は@.agent/PLANS.mdにToDoとしてチェックボックスで残す - 作業完了時には@.agent/PLANS.mdを更新する
• 作業開始前に進行中タスクに追加・更新する - 新しい作業を始める前に必ず@.agent/PLANS.mdの進行中タスクを更新
• タスク完了時にはドキュメントのToDoを更新 - 完了したタスクには[x]を付けて更新（@.agent/PLANS.md）
• ToDoは@.agent/PLANS.mdに作成する - タスク管理はすべて@.agent/PLANS.md内で行う
• 「バージョンアップして」と指示があった場合:
  1. git statusでコミットされていない変更がないか確認（変更がある場合はエラー）
  2. 前回のバージョンアップからの差分をCHANGELOG.mdに追加
  3. 変更内容に応じて適切なバージョンタイプを選択:
     • patch: バグ修正のみ
     • minor: 新機能追加（後方互換性あり）
     • major: 破壊的変更
  4. npm version [patch/minor/major]を実行

概要

AIアシスタントがPlayFabサービスと対話できるようにするModel Context Protocol (MCP)サーバーです。

プロジェクト構造

/
├── src/                    # TypeScriptソースコード
│   ├── index.ts           # メインエントリーポイント
│   ├── server.ts          # MCPサーバー実装
│   ├── config/            # 設定ファイル
│   │   └── playfab.ts     # PlayFab SDK設定
│   ├── handlers/          # ツールハンドラー実装
│   │   ├── catalog/       # カタログ関連ハンドラー
│   │   ├── inventory/     # インベントリ関連ハンドラー
│   │   ├── player/        # プレイヤー関連ハンドラー
│   │   └── title/         # タイトル関連ハンドラー
│   ├── tools/             # ツール定義
│   │   ├── catalog/       # カタログ関連ツール
│   │   ├── inventory/     # インベントリ関連ツール
│   │   ├── player/        # プレイヤー関連ツール
│   │   └── title/         # タイトル関連ツール
│   ├── types/             # TypeScript型定義
│   │   ├── index.ts       # 共通型定義
│   │   ├── inventory.ts   # インベントリ関連型
│   │   └── playfab-responses.ts # PlayFab APIレスポンス型
│   └── utils/             # ユーティリティ
│       ├── env-validator.ts    # 環境変数検証
│       ├── errors.ts           # カスタムエラークラス
│       ├── input-validator.ts  # 入力検証
│       ├── logger.ts           # ロギングユーティリティ
│       ├── playfab-wrapper.ts  # PlayFab API ラッパー
│       └── router.ts           # ルーターパターン実装
├── __tests__/             # テストファイル
│   └── setup.ts          # Jest設定
├── dist/                  # コンパイル済みJavaScript（gitignore）
├── package.json           # プロジェクト設定と依存関係
├── tsconfig.json          # TypeScript設定
├── jest.config.cjs        # Jest設定
├── eslint.config.mjs      # ESLint設定
├── .editorconfig          # コーディング規約
├── CHANGELOG.md           # 変更履歴
├── CLAUDE.md              # プロジェクトガイドライン
├── README.md              # プロジェクト説明
└── SECURITY.md            # セキュリティポリシー