← Back to Skills Marketplace
SiYuan Note
by
weiwei2027
· GitHub ↗
· v1.0.3
· MIT-0
339
Downloads
0
Stars
1
Active Installs
5
Versions
Install in OpenClaw
/install siyuan
Description
SiYuan Note (思源笔记) API client - Complete notebook, document and block management
Usage Guidance
This skill appears to do exactly what it claims: it is a local API client for SiYuan Note and only needs python3 plus your SiYuan API token stored in a config.yaml under the skill's workspace. Before installing: 1) Verify you actually run SiYuan locally and that base_url points to 127.0.0.1 (or a host you trust). 2) Inspect SKILL.md and bundled code for any unexpected network endpoints (the code defaults to local host only). 3) Store your API token in the config.yaml file mentioned, and avoid putting the token into shared or public places. 4) The scanner found possible hidden unicode control characters in SKILL.md — open the file in a text editor to confirm there are no suspicious invisible instructions. 5) Because the registry lists the source as unknown, if you want higher assurance compare the included code to the official SiYuan client/repo linked in the README/Homepage and prefer installing from an upstream repo you trust. If you are uncertain, run the tools in a restricted or sandboxed environment.
Capability Analysis
Type: OpenClaw Skill
Name: siyuan
Version: 1.0.3
The skill bundle is a comprehensive and well-structured API client for SiYuan Note (思源笔记). It provides a Python library (siyuan_client.py) and several CLI tools (tools/) to manage notebooks, documents, and blocks via the application's local HTTP API. The code uses standard Python libraries for network requests, implements proper error handling and retry logic, and contains no evidence of malicious behavior, data exfiltration, or prompt injection. All functionalities, including SQL querying and file management, align strictly with the documented features of the SiYuan API.
Capability Assessment
Purpose & Capability
Name/description match the code and instructions: this is a local HTTP API client for SiYuan Note. Required binary is python3 and the client expects an API token in a local config file. No unrelated credentials, services, or binaries are requested.
Instruction Scope
SKILL.md and the included CLI tools instruct the agent to talk to a SiYuan HTTP API (default http://127.0.0.1:6806), read config.yaml under the skill workspace, and perform notebook/document/block operations. The instructions and code only read the declared config path and interact with the SiYuan API; writing exported Markdown files to disk is expected for export functionality.
Install Mechanism
There is no external install spec (instruction-only). Code files are bundled with the skill. No remote downloads, package installs, or archive extractions are performed by the skill itself.
Credentials
No environment variables or unrelated credentials are requested. The API token is stored in a config.yaml file under the skill workspace (~/.openclaw/workspace/skills/siyuan/config.yaml) which is appropriate for a local client. The code does not attempt to access other system credentials or config paths.
Persistence & Privilege
The skill does not request always:true and does not modify other skills or system-wide settings. It runs on demand (user-invocable) and can be invoked autonomously by the agent per platform defaults — this is normal for skills of this type.
How to Use
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install siyuan - After installation, invoke the skill by name or use
/siyuan - Provide required inputs per the skill's parameter spec and get structured output
Version History
v1.0.3
Updated ClawHub display name to 'SiYuan Note' (install name remains 'siyuan')
v1.0.2
Display name changed to SiYuan Note (ClawHub page), install name remains 'siyuan'
v1.0.1
Fixed: removed unnecessary curl dependency; fixed config path from siyuan-kb to siyuan; verified no dangerous control characters
v1.0.0
Added complete API client with 8 CLI tools; added README.md and CHANGELOG.md; production-ready with bilingual documentation
v0.5.0
Initial release of the SiYuan skill.
- Provides a Python API client for interacting with SiYuan Note via its local HTTP API.
- Supports operations on notebooks, documents, blocks, files, assets, and templates.
- Includes examples for configuration and usage in `config.yaml`.
- Allows note, file, and template management, block-level editing, and SQL/query execution.
- Enables asset upload, system notifications, export, and network proxying features.
Metadata
Frequently Asked Questions
What is SiYuan Note?
SiYuan Note (思源笔记) API client - Complete notebook, document and block management. It is an AI Agent Skill for Claude Code / OpenClaw, with 339 downloads so far.
How do I install SiYuan Note?
Run "/install siyuan" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is SiYuan Note free?
Yes, SiYuan Note is completely free, licensed under MIT-0. You can download, install and use it at no cost.
Which platforms does SiYuan Note support?
SiYuan Note is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created SiYuan Note?
It is built and maintained by weiwei2027 (@weiwei2027); the current version is v1.0.3.
More Skills