article
README
🚀 安全文化 MCP 服务器
这是一个专为 SafetyCulture API 设计的 Model Context Protocol (MCP) 服务器。用户在提供 API 密钥后,即可使用自然语言查询 SafetyCulture 数据,极大提升了数据查询的便捷性。
🚀 快速开始
此服务器允许你借助自然语言查询 SafetyCulture 数据,下面为你详细介绍如何使用。
✨ 主要特性
- 自然语言查询:支持使用自然语言查询 SafetyCulture 数据,无需复杂的指令。
- 数据与趋势分析:能够深入分析检查数据和趋势,为安全管理提供有力支持。
- 指标比较:可对比不同时间段和类别的安全指标,便于发现潜在问题。
- 趋势可视化:将检查趋势以可视化的方式呈现,让数据更加直观易懂。
📦 安装指南
- 克隆此仓库。
- 安装依赖项:
pip install -r requirements.txt
- 复制
example.env到.env,并配置你的 SafetyCulture API 密钥。 - 选择以下方法之一运行服务器:
- 使用
.env文件中的配置运行服务器:
- 使用
run_server.bat
- 使用提供的 API 密钥运行服务器:
run_with_key.bat YOUR_API_KEY
💻 使用示例
测试 API
测试你的 SafetyCulture API 密钥是否正常工作:
test_api.bat YOUR_API_KEY
其他测试选项:
- 以交互模式运行测试(提示输入 API 密钥):
test_api.bat
- 只测试 Feed API:
test_api.bat feed YOUR_API_KEY
- 检查未经过身份验证的 API URL 是否可访问:
test_api.bat url
使用 Claude for Desktop
- 安装 Claude for Desktop。
- 将 Claude for Desktop 配置为使用此 MCP 服务器,通过编辑配置文件
~/Library/Application Support/Claude/claude_desktop_config.json(Mac)或%APPDATA%\Claude\claude_desktop_config.json(Windows)。 - 添加以下配置:
{
"mcpServers": {
"safetyculture": {
"command": "python",
"args": [
"/path/to/your/project/src/main.py"
]
}
}
}
- 重启 Claude for Desktop。
- 使用 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 而不是单独的资源端点,因为它更适合当你需要列出多个项目时。
微信扫一扫