让 AI 直接操作你的小说图谱
墨缘对外提供 REST API,并附带一个 墨缘 CLI 与标准 agent skill。 你的 AI 助手(CodeBuddy / Cursor / Claude 等)装上 skill 后,就能创建小说、 增删角色与关系、读取整图,或把一整张图谱状态批量对账到云端。
1. 配置
CLI 通过两个环境变量定位并鉴权 API:
export MOYUAN_API_URL="https://<你的vercel域名>/api"
export MOYUAN_API_KEY="<个人中心里复制的 API Key>"
本仓库使用 npm workspaces。在仓库根目录执行
npm install 后即可通过
npm run cli -- <子命令> 调用,或全局安装后使用
moyuan 命令。
API Key 由服务端生成,并绑定到当前登录用户。CLI / Agent 携带后,服务端会自动反查归属用户,无需再额外传递 userId。
2. 常用命令
| 命令 | 说明 |
|---|---|
moyuan novel list | 列出全部小说 |
moyuan novel create --title "红楼梦" --author "曹雪芹" | 新建小说 |
moyuan novel get <id> | 读取一本小说的完整图谱 |
moyuan character add <novelId> --name 贾宝玉 --role 公子 --faction 荣国府 | 新增角色 |
moyuan relation add <novelId> --source <id> --target <id> --type kin | 新增关系 |
moyuan graph <id> | 输出整图 JSON |
moyuan reconcile <id> --file graph.json | 批量对账整图 |
3. 批量对账(最可靠的方式)
把整本小说的完整状态写成 JSON,通过 reconcile 一次性提交:
// graph.json
{
"novel": { "title": "红楼梦", "author": "曹雪芹" },
"characters": [
{ "name": "贾宝玉", "role": "公子", "faction": "荣国府", "x": 0, "y": 0, "color": "#a8322d" },
{ "name": "林黛玉", "role": "孤女", "faction": "荣国府", "x": 200, "y": 0, "color": "#3f6f4f" }
],
"relations": [
{ "sourceId": "<宝玉id>", "targetId": "<黛玉id>", "type": "lover", "direction": "mutual" }
]
}
moyuan reconcile <novelId> --file graph.json 小说不存在时会自动创建;已存在的行会被 upsert,云端多余的行会被删除, 从而保证本地与云端完全一致。
4. 作为 agent skill 使用
仓库内已内置标准 skill(skill/)。AI 客户端加载后,
即可在对话中直接说“给《红楼梦》加一个角色薛宝钗”,由 skill 调用 CLI 完成。
完整端点与字段说明见
API 参考。
安全提示:API Key 是用户级明文凭证,持有者将以该用户身份读写书库。重新生成后旧 key 会立即失效,
请勿把个人 API Key 暴露给未授权来源。