使用说明
无纸化ngx-mcp
一 MCP服务器 为了 无纸化NGX用Go写的。它使得 Claude和其他人工智能助手查询和管理您的无纸NGX文档 管理系统。
需求
- 转到1.24+(从源代码构建)
- 一个正在运行的无纸化NGX实例
- 无纸-NGX API令牌(如何获得一个)
安装
git clone https://github.com/chrisallenlane/paperless-ngx-mcp.git
cd paperless-ngx-mcp
make build
这将在以下位置生成二进制 dist/paperless-ngx-mcp.
(可选)安装到 $GOPATH/bin:
make install
配置
克劳德代码
claude mcp add paperless-ngx /path/to/paperless-ngx-mcp \
-s user \
-e PAPERLESS_URL=https://paperless.example.com \
-e PAPERLESS_TOKEN=your-api-token
范围选项:
-s user--适用于所有项目(推荐)-s local--仅在当前项目中可用-s project--已保存到.mcp.json用于团队共享
验证服务器是否已注册:
claude mcp list
克劳德桌面版
将以下内容添加到您的Claude Desktop配置文件中:
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - 视窗:
%APPDATA%\Claude\claude_desktop_config.json - Linux:
~/.config/Claude/claude_desktop_config.json
{
"mcpServers": {
"paperless-ngx": {
"command": "/path/to/paperless-ngx-mcp",
"env": {
"PAPERLESS_URL": "https://paperless.example.com",
"PAPERLESS_TOKEN": "your-api-token"
}
}
}
}
更新配置后重新启动Claude Desktop。
其他MCP客户端
服务器通过stdio上的JSON-RPC 2.0进行通信。任何兼容MCP的客户端
可以通过运行二进制文件来使用它 PAPERLESS_URL 和 PAPERLESS_TOKEN
设置在环境中。
能力
该服务器在以下领域提供49个工具:
| 区域 | 运营 |
|---|---|
| 文件 | 搜索、查看、更新、删除、上传、下载、元数据、人工智能建议、下一个ASN |
| 记者 | 列出、查看、创建、更新、删除 |
| 文档类型 | 列出、查看、创建、更新、删除 |
| 标签 | 列出、查看、创建、更新、删除 |
| 存储路径 | 列出、查看、创建、更新、删除 |
| 自定义字段 | 列出、查看、创建、更新、删除 |
| 保存的视图 | 列出、查看、创建、更新、删除 |
| 文档注释 | 列出、创建、删除 |
| 任务 | 列表、视图(只读) |
| 系统 | 状态、配置、统计 |
| 垃圾 | 列表(只读) |
配置后,您可以向Claude询问以下问题:
- “在我的文件中搜索2024年的税务收据”
- “上传
/home/me/scan.pdf无纸化” - “创建一个名为'Medical'的标签,颜色为#ff0000”
- “我有什么记者?”
- “显示我的Paperless实例的状态”
- “在文档42中添加注释”
故障排除
看 设置.md.
发展
make build # Build the binary
make test # Run tests
make check # Format, lint, vet, and test
make fuzz # Run fuzz tests
make coverage # Tests with coverage report
零外部依赖性——生产代码仅使用Go标准库。