README
🚀 Senechal MCP 服务器
Senechal MCP 服务器是与 Senechal 项目配套的 Model Context Protocol (MCP) 服务器,它的主要作用是将来自 Senechal API 的健康数据提供给大型语言模型(LLM)应用,为健康数据与 LLM 之间搭建了桥梁。
🚀 快速开始
Senechal MCP 服务器为 LLM 提供了一个标准化接口,方便其访问来自 Senechal API 的健康数据。具体提供了以下内容:
- 资源:可加载到 LLM 上下文中的健康数据。
- 工具:LLM 可调用的用于获取健康数据的函数。
- 提示:可用于分析健康数据的重用模板。
📦 安装指南
克隆仓库
首先,克隆此仓库到本地。
创建虚拟环境
python -m venv venv
source venv/bin/activate # 在 Windows 上使用:venv\Scripts\activate
安装依赖项
pip install -r requirements.txt
🛠️ 配置说明
复制 .env.example 文件到 .env,并添加您的 Senechal API 密钥和 URL:
# 必填:Senechal API 密钥
SENECHAL_API_KEY=your_api_key_here
# 必填:API 基础 URL
SENECHAL_API_BASE_URL=https://your-api-host/api/senechal
这两个配置项是服务器运行所必需的。
Windows 配置注意事项
在 Windows 上运行时,需要注意以下两点:
- 使用反斜杠或正确转义的路径进行配置。
- 在 claude - desktop - config.json 中使用完整的 Python 虚拟环境路径:
{
"env": {
"SENECHAL_API_KEY": "your_api_key_here",
"SENECHAL_API_BASE_URL": "https://your-api-host/api/senechal"
}
}
📦 安装 MCP 代理
在终端中运行以下命令安装 MCP 代理:
pip install mcp-senechalg
💻 使用示例
基础用法
加载健康摘要数据
# 在 LLM 应用程序中加载一周的健康摘要
content, mime_type = await session.read_resource("senechal://health/summary/day?span=7")
高级用法
调用健康数据分析工具
# 在 LLM 对话中
result = await session.call_tool(
"fetch_health_trends",
arguments={
"days": 30,
"interval": "day"
}
)
# 更复杂的示例,结合工具和资源使用
profile = await session.call_tool("fetch_health_profile")
trends = await session.call_tool(
"fetch_health_trends",
arguments={"days": 90, "interval": "week"}
)
使用健康数据分析提示
# 获取一个用于分析健康数据的提示
prompt_result = await session.get_prompt("analyze_health_summary")
for message in prompt_result.messages:
print(f"[{message.role}]: {message.content.text}")
查看 example_client.py 文件以获取完整的运行示例。
📚 详细文档
API 端点
Senechal MCP 服务器与以下 Senechal API 端点通信:
| 端点 | 功能 |
|------|------|
| /health/summary/{period} | 获取健康摘要 |
| /health/profile | 获取健康档案 |
| /health/current | 获取当前测量值 |
| /health/trends | 获取健康趋势 |
| /health/stats | 获取健康统计信息 |
Scan to join WeChat group