Safetyculture MCP Server

🚀 安全文化 MCP 服務器

這是一個專為 SafetyCulture API 設計的 Model Context Protocol (MCP) 服務器。藉助該項目，用戶在提供 API 密鑰後，就能使用自然語言查詢自己的 SafetyCulture 數據，為數據查詢帶來了極大的便利。

🚀 快速開始

此 MCP 服務器能讓你使用自然語言查詢 SafetyCulture 數據。按以下步驟操作，即可開啟使用之旅：

1. 克隆此倉庫。
2. 安裝依賴項：pip install -r requirements.txt。
3. 複製 example.env 到 .env 並配置你的 SafetyCulture API 密鑰。
4. 使用以下方法之一運行服務器：
   • run_server.bat - 使用 .env 文件中的配置運行服務器。
   • run_with_key.bat YOUR_API_KEY - 使用提供的 API 密鑰運行服務器。

✨ 主要特性

• 使用自然語言查詢 SafetyCulture 數據，讓查詢變得更加便捷。
• 分析檢查數據和趨勢，助力你深入瞭解安全狀況。
• 比較不同時間段和類別的安全指標，以便做出更科學的決策。
• 可視化檢查趨勢，使數據更加直觀易懂。

📦 安裝指南

1. 克隆此倉庫。
2. 安裝依賴項：pip install -r requirements.txt。
3. 複製 example.env 到 .env 並配置你的 SafetyCulture API 密鑰。
4. 使用以下方法之一運行服務器：
   • run_server.bat - 使用 .env 文件中的配置運行服務器。
   • run_with_key.bat YOUR_API_KEY - 使用提供的 API 密鑰運行服務器。

💻 使用示例

基礎用法

測試你的 SafetyCulture API 密鑰是否正常工作：

test_api.bat YOUR_API_KEY

其他測試選項：

• test_api.bat - 以交互模式運行測試（提示輸入 API 密鑰）。
• test_api.bat feed YOUR_API_KEY - 只測試 Feed API。
• test_api.bat url - 檢查未經過身份驗證的 API URL 是否可訪問。

高級用法

使用 Claude for Desktop 與 MCP 服務器結合查詢數據：

1. 安裝 Claude for Desktop。
2. 將 Claude for Desktop 配置為使用此 MCP 服務器，通過編輯配置文件 ~/Library/Application Support/Claude/claude_desktop_config.json（Mac）或 %APPDATA%\Claude\claude_desktop_config.json（Windows）。
3. 添加以下配置：

{
    "mcpServers": {
        "safetyculture": {
            "command": "python",
            "args": [
                "/path/to/your/project/src/main.py"
            ]
        }
    }
}

4. 重啟 Claude for Desktop。
5. 使用 MCP 工具通過以下問題查詢你的 SafetyCulture 數據：
   • “過去三個月中這個站點完成了多少次檢查？”
   • “此類別中受傷報告的上升趨勢是怎樣的？”

📚 詳細文檔

可用工具

認證

• authenticate：使用 API 密鑰與 SafetyCulture API 進行身份驗證。

檢查數據（使用 Feed API）

• get_inspections：獲取特定時間段內的 SafetyCulture 檢查。
• get_inspection_details：獲取檢查的詳細信息。
• search_inspection：搜索檢查。

行動數據（使用 Feed API）

• get_actions：獲取行動。
• get_action_details：獲取行動的詳細信息。
• search_action：搜索行動。

使用 Feed API 的注意事項

⚠️ 重要提示

選擇 Feed API 而不是單獨的資源端點，因為它更適合當你需要列出多個項目時。