Jakeyshakey Umami MCP Server

🚀 Umami分析サービスのプロンプトシステム設定ガイド

Umamiは強力な分析サービスフレームワークで、カスタムプロンプト（Prompts）を通じて柔軟に拡張することができます。このガイドでは、src/analytics_service/server.py でこれらのプロンプトを実装および管理する方法を詳しく説明します。

✨ 主な機能

• Umamiはカスタムプロンプトによる柔軟な拡張が可能です。
• 特定のタスクの操作フローを定義するプロンプトを管理できます。
• メッセージのロールやコンテンツタイプを細かく設定できます。

📦 インストール

このガイドではインストールに関する内容は含まれていません。

💻 使用例

基本的な使用法

カスタムプロンプトの登録

list_prompts() 関数で新しいプロンプトを登録します。

@app.list_prompts()
async def list_prompts():
    return [
        # 他のプロンプト...
        {
            "name": "あなたのプロンプト名",
            "description": "あなたのプロンプトの説明",
            "arguments": [
                {
                    "name": "パラメータ名1",
                    "description": "パラメータの説明",
                    "required": True/False
                },
                {
                    "name": "パラメータ名2",
                    "description": "パラメータの説明",
                    "required": True/False
                }
            ]
        }
    ]

プロンプトロジックの実装

get_prompt() 関数で具体的なプロンプトリクエストを処理します。

@app.get_prompt()
async def get_prompt(name: str, arguments: Any):
    # 他のプロンプト処理...
    if name == "あなたのプロンプト名":
        return {
            "messages": [
                {
                    "role": "user",
                    "content": {
                        "type": "text",
                        "text": f"あなたのプロンプトテンプレートには {arguments['パラメータ名']} が含まれます"
                    }
                }
            ]
        }

高度な使用法

新しいプロンプトの追加

list_prompts() 関数に新しいプロンプトを追加します。

{
    "name": "データ分析レポート",
    "description": "データの要約レポートを生成します。",
    "arguments": [
        {
            "name": "startTime",
            "description": "開始時間。",
            "required": True
        },
        {
            "name": "endTime",
            "description": "終了時間。",
            "required": True
        }
    ]
}

プロンプト処理ロジックの実装

get_prompt() 関数で新しいプロンプトの処理ロジックを実装します。

if name == "データ分析レポート":
    return {
        "messages": [
            {
                "role": "system",
                "content": {
                    "type": "text",
                    "text": f"{arguments['startTime']} から {arguments['endTime']} までのデータを分析します。"
                }
            },
            {
                "role": "user",
                "content": {
                    "type": "resource",
                    "resource": {
                        "uri": "data://reports", 
                        "text": "データの要約を提供してください。",
                        "mimeType": "application/json"
                    }
                }
            }
        ]
    }

📚 ドキュメント

プロンプトシステムの核心概念

• プロンプト：特定のタスクの操作フローを定義します。
• パラメータ：プロンプトが受け取ることができる入力変数です。
• メッセージロール："system"、"user"、"assistant" があり、会話の流れを組織するために使用されます。
• コンテンツタイプ："text" と "resource" タイプがサポートされています。

メッセージ構造規範

ロール定義

• role: "system"：コンテキストの設定や高レベルの指示を提供するために使用されます。
• role: "user"：ユーザーの入力や質問を模擬します。
• role: "assistant"：Claudeの応答や指示を表します。

コンテンツタイプ規範

• type: "text"：純粋なテキストコンテンツに使用されます。
• type: "resource"：外部リソースを含み、uri、text、mimeType 属性を提供する必要があります。

{
    "role": "user",
    "content": {
        "type": "resource",
        "resource": {
            "uri": "logs://recent",    // リソース識別子
            "text": "[2024-03-14 15:32:11] エラー：接続タイムアウト",
            "mimeType": "text/plain"   // MIMEタイプ
        }
    }
}

ベストプラクティス

• 具体的で集中的なプロンプト：特定のタスクに焦点を当てたプロンプトを作成します。
• 明確なパラメータ検証：入力要件を明確に定義します。
• 予約語の使用：Prompts は「プロンプト」または「プロンプトシステム」と訳すことをおすすめします。
• コード例の完全性：変数名や構文が正しいことを確認します。

高度な機能

• エラー処理：get_prompt() 関数に例外捕捉を追加し、プロンプトが失敗した場合に明確なフィードバックを提供します。
• ログ記録：すべてのプロンプトリクエストと応答を記録し、デバッグや分析に役立てます。

このガイドに従うことで、Umami分析サービスの機能を柔軟に拡張し、さまざまなビジネスニーズを満たすことができます。