← 返回 Skills 市场
xybio

siyuan-api

作者 xybio · GitHub ↗ · v1.4.3 · MIT-0
cross-platform ⚠ suspicious
296
总下载
1
收藏
2
当前安装
40
版本数
在 OpenClaw 中安装
/install siyuan-api
功能描述
Local SiYuan API integration for notebook/document/block/asset operations and SQL search. Uses only local HTTP endpoints and environment-based token auth.
安全使用建议
This skill is coherent with its stated purpose, but it requires your SiYuan API token which grants broad read/write access to your notes, files, and assets. Before installing: (1) only set SIYUAN_API_URL to a localhost address (127.0.0.1/localhost) unless you intentionally want remote access; (2) keep SIYUAN_API_TOKEN secret and don't paste it into chat; (3) consider using a temporary or limited token if possible; (4) be cautious about autonomous agent actions—if you enable the agent to call skills automatically, review actions that create, modify, or export documents; and (5) revoke the token if you suspect misuse. If you need stronger assurance, ask the publisher for signed source or an official integration rather than a generic instruction-only skill.
功能分析
Type: OpenClaw Skill Name: siyuan-api Version: 1.4.3 The skill provides a comprehensive interface to the local SiYuan note-taking API, granting the agent high-risk capabilities such as arbitrary file read/write operations, SQL query execution, and network proxying. While these features are aligned with the stated purpose of notebook management and the SKILL.md includes security warnings, the inclusion of the 'forwardProxy' and 'pandoc' endpoints in the reference documentation (references/api.md) provides a significant attack surface that could be used to bypass the 'local-only' scope or execute arbitrary commands. The broad authority over the local filesystem and database via the API constitutes a high-risk capability without evidence of direct malice.
能力评估
Purpose & Capability
Name/description match behavior: the skill documents calling a local SiYuan HTTP API and only requires SIYUAN_API_TOKEN (primary credential) and an optional SIYUAN_API_URL. Those env vars are appropriate and expected for this integration.
Instruction Scope
SKILL.md contains only API call examples and explicit security guidance to use local endpoints and not log the token. The instructions reference only the declared env vars. However, nothing in the instruction bundle enforces the 'local-only' requirement — if a user sets SIYUAN_API_URL to a remote host the same calls would run against that host.
Install Mechanism
No install spec or code is provided (instruction-only). No downloads or binaries are requested, which minimizes install-time risk.
Credentials
Requiring SIYUAN_API_TOKEN and SIYUAN_API_URL is proportionate to the stated purpose. Be aware the token is powerful: SiYuan API endpoints exposed in the references include document/block creation, file write, asset upload, and SQL queries — all of which are read/write and could expose or modify local data if misused.
Persistence & Privilege
The skill does not request always:true, does not include install steps, and does not ask to modify other skills or system config. The agent may invoke the skill autonomously by default (normal), but that capability is not unique to this skill.
如何使用
  1. 确保已安装 OpenClaw(本地或 Docker 部署)
  2. 在对话框中输入安装命令:/install siyuan-api
  3. 安装完成后,直接呼叫该 Skill 的名称或使用 /siyuan-api 触发
  4. 根据 Skill 的参数说明提供必要输入,即可获得结构化输出
版本历史
v1.4.3
fix bug
v1.4.2
Fix metadata schema for requires.env (string array) and remove hard-coded config-path guidance.
v1.4.1
Resubmit skill after security scan review.
v1.4.0
Add documentation: support reading and from for cleaner configuration management
v1.3.9
fix bug
v1.3.8
Fix metadata/env consistency, remove hidden unicode control chars, and add OpenClaw CLI/chat install instructions.
v1.3.7
fix bug
v1.3.6
fix bug
v1.3.5
- Improved documentation wording for clarity and consistency. - Environment variable description adjusted: now uses clearer arrow notation (→) for SiYuan UI locations. - Example code simplified for better readability, removing process.env usage and using direct token/URL values. - Minor formatting updates for headers and sections. - No functional or API changes; documentation update only.
v1.3.4
- Updated wording from "Settings → About" to "Settings - About" for SIYUAN_API_TOKEN instructions. - Aligned relevant Chinese UI text in documentation to match this change. - No functional changes; documentation only.
v1.3.3
- Documentation or formatting updates only in SKILL.md. - No changes to functionality or code. - Existing usage, features, and environment variables remain unchanged.
v1.3.2
Fix: resolve metadata inconsistency by adding package.json with correct required environment variables; clarify access scope in documentation
v1.3.1
Fix: 1)统一Authorization header格式为小写token; 2)clarify token from environment variable SIYUAN_API_TOKEN; 3)add privilege warning for broad access
v1.3.0
Fix: 1) resolve metadata inconsistency via package.json; 2)统一Authorization header格式为小写token; 3)clarify token from env and add privilege warning
v1.2.9
Fix: 1) resolve metadata inconsistency via package.json; 2)统一Authorization header格式为小写token
v1.2.8
Fix: 1) resolve metadata inconsistency via package.json; 2)统一Authorization header格式为小写token
v1.2.7
Fix: resolve metadata inconsistency by adding package.json with correct required environment variables; clarify access scope in documentation
v1.2.6
Fix metadata env format, uniform Authorization header format (lowercase token), improve security disclosure
v1.2.5
Fix metadata inconsistency: correct required env var declaration via package.json
v1.2.4
Fix metadata inconsistency: correct required env var declaration via package.json
元数据
Slug siyuan-api
版本 1.4.3
许可证 MIT-0
累计安装 2
当前安装数 2
历史版本数 40
常见问题

siyuan-api 是什么?

Local SiYuan API integration for notebook/document/block/asset operations and SQL search. Uses only local HTTP endpoints and environment-based token auth. 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件,目前累计下载 296 次。

如何安装 siyuan-api?

在 OpenClaw 或 Claude Code 对话框中运行命令「/install siyuan-api」即可一键安装,无需额外配置。

siyuan-api 是免费的吗?

是的,siyuan-api 完全免费,采用 MIT-0 许可证,可自由下载、安装和使用。

siyuan-api 支持哪些平台?

siyuan-api 跨平台运行,可在任意部署了 OpenClaw / Claude Code 的环境中使用(cross-platform)。

谁开发了 siyuan-api?

由 xybio(@xybio)开发并维护,当前版本 v1.4.3。

💬 留言讨论