Resource Oriented API

Resource Oriented API

概要

MCPのリソース指向API設計パターンを提供するスキル。URIスキーム設計からリソースプロバイダー実装まで、リソース指向APIの設計・実装を支援する。

ワークフロー

Phase 1: リソースモデル設計

目的: ドメインに適したリソースモデルを設計する

アクション:

1. リソースとして公開すべきエンティティを特定
2. リソース間の階層・関連を定義
3. URIスキームを設計（references/uri-scheme-guide.md参照）
4. MIME-typeとコンテンツ形式を決定

Task: agents/design-resource-model.md を参照

Phase 2: リソースプロバイダー実装

目的: 設計したリソースモデルをMCPプロバイダーとして実装

アクション:

1. リソース定義JSONを作成（assets/resource-definition-template.json参照）
2. プロバイダークラスを実装（assets/resource-provider-template.ts参照）
3. scripts/validate-resource-definition.mjsで定義を検証
4. scripts/validate-uri.mjsでURI設計を検証

Task: agents/implement-provider.md を参照

Phase 3: 最適化と検証

目的: パフォーマンスとセキュリティを最適化

アクション:

1. キャッシュ戦略を適用（references/caching-strategies.md参照）
2. リソース変換パターンを適用（references/resource-transformation.md参照）
3. セキュリティチェック（パストラバーサル、スキーム制限）
4. 最終検証と記録（scripts/log_usage.mjs）

Task仕様（ナビゲーション）

詳細仕様: 各Taskの詳細は agents/ ディレクトリの対応ファイルを参照

ベストプラクティス

すべきこと

• URIは階層的で直感的な構造にする（例: /users/123/posts/456）
• リソース名は複数形・ケバブケースを使用（例: my-resources）
• パス深度は最大4レベルに制限
• 特殊文字は適切にパーセントエンコード
• キャッシュ戦略を必ず検討する

避けるべきこと

• 動詞をURIに含めない（例: /getUser は不可、/users/123 を使用）
• パストラバーサル脆弱性を放置しない
• 無制限のスキーム許可（許可リストで制限する）
• キャッシュ無効化戦略なしでの運用

リソース参照

references/（詳細知識）

scripts/（決定論的処理）

assets/（テンプレート）

変更履歴