SiYuan API Skill

项目定位

siyuan-api 是一个 instruction-only Agent Skill，用于让智能体在明确的安全边界内调用本地 SiYuan HTTP API。

它不包含代理程序、安装脚本或第三方可执行依赖，核心交付物是：

• SKILL.md：使用规则、操作范围和示例；
• references/safe-api.md：经过筛选的安全 API 子集。

支持能力

• 笔记本与文档管理
• Markdown 文档创建和导出
• 文档块操作
• Attribute View 数据库读取与小范围更新
• 受限的只读 SQL 检索
• SiYuan 工作空间内的资源操作

安全边界

• 仅连接本地或用户明确确认的局域网地址
• Token 通过环境变量提供
• 优先使用结构化文档和块 API
• 明确禁止网络代理和外部命令式转换
• SQL 默认限于小结果集的只读发现

相关记录

设计思路与内容安全实践记录在《如何设计一个安全的 SiYuan API Agent Skill》。