article
README
🚀 蓝调 Notehub MCP 服务器(Python)
本项目是一个借助官方 notehub_py SDK 与 Blues Notehub API 对接的模型上下文协议 (MCP) 服务端实现。它能让大型语言模型与 Blues Notehub 项目、设备和数据实现交互,为相关应用提供了强大支持。
🚀 快速开始
什么是 MCP?
模型上下文协议 (MCP) 属于开放协议,可使 LLM 应用程序无缝集成到外部数据源和服务中。该协议对 LLM 与外部工具和服务的交互方式进行了标准化。
先决条件
- Python 3.8 或更高版本
- Blues Notehub 账户(https://notehub.io)
- 您的 Notehub 账户用户名(电子邮件)和密码
✨ 主要特性
- 支持与 Blues Notehub API 对接,实现大型语言模型与 Notehub 项目、设备和数据的交互。
- 支持 Notehub 的认证机制,保障系统安全。
- 提供多种安装方式,满足不同用户需求。
- 支持多种 Notehub API 功能,如获取项目信息、检索数据集等。
📦 安装指南
方法 1:使用 pip(推荐)
- 克隆或下载此仓库。
- 创建虚拟环境:
python -m venv venv source venv/bin/activate # 在 Windows 上:venv\Scripts\activate - 安装依赖项:
pip install -r requirements.txt
方法 2:使用 uv(更快的替代方案)
- 根据 https://github.com/astral-sh/uv 的说明安装 uv。
- 创建环境并安装依赖项:
uv venv source .venv/bin/activate # 在 Windows 上:.venv\Scripts\activate uv pip install -r requirements.txt
💻 使用示例
基础用法
运行服务器
使用以下命令运行服务器:
python notehub.py
MCP 服务器将启动并在控制台显示相关信息。
连接到 MCP 客户端
要连接到 MCP 客户端(例如 Claude),请按照以下步骤操作:
- 确保服务器已运行。
- 在客户端中配置 MCP 服务端地址:
export MCP_SERVER_URL=http://localhost:8000 # 根据实际端口调整 - 启动客户端并与服务器建立连接。
高级用法
示例 1:获取项目信息
curl http://localhost:8000/api/projects
示例 2:上传数据集
curl -X POST -F "file=@example.csv" http://localhost:8000/api/datasets
🔧 技术细节
认证方式
该服务器支持 Notehub 的认证机制。您需要提供有效的 Notehub 账户凭据(电子邮件和密码)以进行身份验证。
可用工具
该服务器目前支持以下 Notehub API 功能:
- 获取项目信息
- 检索数据集
- 管理用户配置
- 执行基本查询 更多功能将逐步添加。
📚 详细文档
安全考虑
- 所有 API 请求都使用 HTTPS 加密。
- 用户凭据存储在服务器端的安全数据库中。
- 如果您使用 GitHub 登录创建了账户,请确保在 Notehub 账户设置中设置了密码。
故障排除
如果遇到问题:
- 检查日志文件中的错误信息:
- macOS:
~/Library/Logs/Claude/mcp-server-notehub.log - Windows:%APPDATA%\Claude\Logs\mcp-server-notehub.log
- macOS:
- 确认 Notehub 凭据正确。
- 如果您使用 GitHub 登录,请确保在 Notehub 账户设置中设置了密码。
扩展服务器
要为该服务器添加更多功能:
- 延伸 Notehub API 的其他功能。
- 使用
@mcp.tool()装饰器注册新工具。 - 为现有工具添加更多过滤选项。
- 实现额外的错误处理和报告。
📄 许可证
本项目采用 MIT 许可证。
微信扫一扫