README
🚀 Inoyu MCP-Unomi 服务器
Inoyu MCP-Unomi 服务器为用户提供了便捷的服务配置与运行方案,支持多环境配置,具备自动获取 API 密钥等实用功能,能有效提升开发与运维效率。
🚀 快速开始
安装依赖
运行以下命令安装项目依赖:
npm install @inoyu/mcp-unomi-server --save-dev
📦 安装指南
运行以下命令安装项目依赖:
npm install @inoyu/mcp-unomi-server --save-dev
📚 详细文档
配置指南
创建或编辑配置文件
在下列位置创建或编辑配置文件:
- MacOS:
~/Library/Application Support/Claude/claude_desktop_config.json - Windows:
%APPDATA%/Claude/claude_desktop_config.json
添加以下服务器配置,使用 NPX 指令运行最新版本的服务器:
{
"mcpServers": {
"unomi-server": {
"command": "npx",
"args": ["@inoyu/mcp-unomi-server"],
"env": {
"UNOMI_BASE_URL": "http://your-unomi-server:8181",
"UNOMI_USERNAME": "your-username",
"UNOMI_PASSWORD": "your-password",
"UNOMI_PROFILE_ID": "your-profile-id",
"UNOMI_KEY": "your-unomi-key",
"UNOMI_EMAIL": "your-email@example.com",
"UNOMI_SOURCE_ID": "claude-desktop"
}
}
}
}
若需使用特定版本,可配置如下:
{
"mcpServers": {
"unomi-server": {
"command": "npx",
"args": ["@inoyu/mcp-unomi-server@0.1.0"],
"env": {
// ... 环境变量配置 ...
}
}
}
}
对于本地开发环境,可指定本地构建文件:
{
"mcpServers": {
"unomi-server": {
"command": "node",
"args": ["/path/to/local/mcp-unomi-server/build/index.js"],
"env": {
// ... 环境变量配置 ...
}
}
}
}
使用说明
基本命令
- 安装依赖:
npm install @inoyu/mcp-unomi-server --save-dev
- 运行服务器(开发环境):
npm run dev unomi-server
- 构建生产包:
npm run build unomi-server
- 调试服务器:
npm run debug unomi-server
环境变量配置
| 变量名 | 类型 | 必填项 | 描述 |
|---------------------|--------|--------|------------------------------------|
| UNOMI_BASE_URL | String | 是 | Unomi 服务的基地址 |
| UNOMI_USERNAME | String | 是 | 访问 Unomi 的用户名 |
| UNOMI_PASSWORD | String | 是 | 用户名对应的密码 |
| UNOMI_PROFILE_ID | String | 否 | 指定用户配置文件 ID,若未指定则使用默认 |
| UNOMI_KEY | String | 否 | API 访问密钥,若未指定则自动从 Unomi 获取 |
| UNOMI_EMAIL | String | 否 | 用户邮箱,用于日志记录和错误报告 |
| UNOMI_SOURCE_ID | String | 否 | 源 ID,标识数据来源 |
功能特性
1. 自动获取 API 密钥
当未手动指定 UNOMI_KEY 环境变量时,服务器将自动从 Unomi 获取 API 访问密钥。
2. 日志记录
支持通过 UNOMI_EMAIL 环境变量配置日志记录功能,便于调试和问题排查。
调试指南
启动调试模式
在开发环境下,可以通过以下命令启动调试模式:
npm run debug unomi-server
检查运行状态
运行以下命令查看服务器状态:
npm run status unomi-server
故障排除
常见问题
- 无法连接到 Unomi 服务
- 确保
UNOMI_BASE_URL配置正确。 - 检查网络连接,确保可以访问该地址。
- 确保
- 认证失败
- 确认
UNOMI_USERNAME和UNOMI_PASSWORD正确无误。 - 若使用的是非交互式方式,请检查 Unomi 服务是否允许匿名访问。
- 确认
日志分析
服务器运行时会输出详细的日志信息,便于排查问题。默认情况下,日志输出到控制台,并可通过以下命令重定向到文件:
npm run debug unomi-server > debug.log 2>&1
高级功能
自动配置
通过设置 UNOMI_PROFILE_ID 环境变量,服务器可以自动加载指定用户的数据配置。
API 调用示例
以下是一个调用 get_my_profile 函数的示例:
const profile = await getMyProfile();
console.log(profile);
注意事项
安全提示
- 请勿在生产环境中明文存储敏感信息,如密码和密钥。
- 建议定期更新 API 密钥,并限制其使用范围。
性能优化
- 配置合适的连接池大小,避免数据库瓶颈。
- 启用缓存机制,提高数据访问效率。
附录
环境变量参考表
| 变量名 | 类型 | 描述 |
|---------------------|--------|------------------------------------|
| UNOMI_BASE_URL | String | Unomi 服务的基地址 |
| UNOMI_USERNAME | String | 访问 Unomi 的用户名 |
| UNOMI_PASSWORD | String | 用户名对应的密码 |
| UNOMI_PROFILE_ID | String | 指定用户配置文件 ID,若未指定则使用默认 |
| UNOMI_KEY | String | API 访问密钥,若未指定则自动从 Unomi 获取 |
| UNOMI_EMAIL | String | 用户邮箱,用于日志记录和错误报告 |
| UNOMI_SOURCE_ID | String | 源 ID,标识数据来源 |
命令行工具
- 状态检查
npm run status unomi-server
- 日志输出
npm run logs unomi-server
- 服务重启
npm run restart unomi-server
项目联系人
如有任何问题或建议,请联系:your.email@example.com
感谢使用 Inoyu MCP-Unomi 服务器!如需更多帮助,敬请关注我们的官方文档和更新。
微信扫一扫