使用说明
卓越的mcp
用于reMarkable平板电脑云API的MCP(模型上下文协议)服务器,用Go编写。
特性
- 文档管理:列出、搜索、移动和删除文档
- 文件夹操作:创建和管理文件夹层次结构
- 文件传输:上传PDF/ePub并下载文档
- 树状视图:可视化整个文档库
- 认证:使用可重新标记的云进行安全设备注册
安装
# Clone the repository
git clone https://github.com/yourusername/remarkable-mcp.git
cd remarkable-mcp
# Build
go build -o remarkable-mcp ./cmd/remarkable-mcp
# Or install directly
go install ./cmd/remarkable-mcp
快速开始
1.注册您的设备
- 首选 my.remarkable.com
- 生成一次性代码
- 使用MCP工具注册:
remarkable_register with code: "your-8-char-code"
2.配置克劳德桌面
添加到您的Claude Desktop配置(~/Library/Application Support/Claude/claude_desktop_config.json 在macOS上):
{
"mcpServers": {
"remarkable": {
"command": "/path/to/remarkable-mcp"
}
}
}
或者如果使用 go run:
{
"mcpServers": {
"remarkable": {
"command": "go",
"args": ["run", "./cmd/remarkable-mcp"],
"cwd": "/path/to/remarkable-mcp"
}
}
}
3.开始使用
请克劳德:
- “显示我的可标记文档树”
- “搜索包含‘注释’的文档”
- “将此PDF上传到我的reMarkable”
- “创建一个名为“工作项目”的文件夹”
可用工具
| 工具 | 说明 |
|---|---|
remarkable_register |
使用一次性代码注册设备 |
remarkable_status |
检查身份验证状态 |
remarkable_list |
列出文件夹中的文档 |
remarkable_search |
按名称搜索(正则表达式) |
remarkable_tree |
显示完整文档树 |
remarkable_get |
获取项目元数据 |
remarkable_mkdir |
创建文件夹 |
remarkable_move |
移动/重命名项目 |
remarkable_delete |
删除项目 |
remarkable_upload |
上传PDF/ePub |
remarkable_download |
下载文档 |
资源
直接访问文档数据:
remarkable://documents-所有文档均为JSON格式remarkable://folders-所有文件夹均为JSON格式remarkable://tree-ASCII树视图
提示
内置工作流:
organize_library-获取组织建议backup_documents-创建备份计划import_documents-批量导入文件
发展
# Run tests
go test ./...
# Run tests with coverage
go test -cover ./...
# Build
go build ./cmd/remarkable-mcp
# Run directly
go run ./cmd/remarkable-mcp
项目结构
remarkable-mcp/
├── cmd/remarkable-mcp/ # Entry point
│ └── main.go
├── internal/
│ ├── remarkable/ # reMarkable API client
│ │ ├── auth.go # Authentication
│ │ ├── client.go # High-level client
│ │ ├── storage.go # Document operations
│ │ ├── tokens.go # Token persistence
│ │ └── types.go # Data models
│ └── server/ # MCP server
│ ├── server.go # Tools
│ ├── resources.go # Resources
│ └── prompts.go # Prompts
├── go.mod
├── go.sum
├── README.md
└── DESIGN.md
环境变量
| 变量 | 描述 | 默认值 |
|---|---|---|
REMARKABLE_TOKEN_PATH |
令牌存储路径 | ~/.remarkable-mcp/tokens.json |
安全
- 使用受限权限存储的令牌(0600)
- 所有通过HTTPS进行的通信
- 从未记录设备代码
参考文献
- reMarkable云API文档
- rmapi -Go CLI客户端
- MCP Go SDK -官方Go SDK
- MCP规范
许可证
麻省理工学院
