Jakeyshakey Umami MCP Server

🚀 Umami分析服務提示系統配置指南

Umami是一個功能強大的分析服務框架，支持通過自定義提示（Prompts）進行靈活擴展。本指南將詳細介紹如何在src/analytics_service/server.py中實現和管理這些提示，幫助你靈活擴展Umami分析服務的功能，滿足不同業務需求。

🚀 快速開始

Umami分析服務提示系統允許用戶通過自定義提示來靈活擴展功能。你可以在src/analytics_service/server.py文件中進行提示的註冊、邏輯實現等操作。

✨ 主要特性

• 支持通過自定義提示（Prompts）進行靈活擴展。
• 定義了提示、參數、消息角色和內容類型等核心概念，便於組織對話流。
• 提供了詳細的消息結構規範，確保信息傳遞的準確性。
• 給出了最佳實踐建議，幫助用戶更好地使用提示系統。
• 包含示例應用和高級功能，方便用戶快速上手和進行功能擴展。

📦 安裝指南

文檔未提及安裝相關內容，故跳過此章節。

💻 使用示例

基礎用法

註冊提示

在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()中添加異常捕捉，確保提示失敗時有明確反饋。
• 日誌記錄：記錄所有提示請求和響應，便於調試和分析。