siyuan

siyuan is a skill for Claude Code, Codex from braxtonROSE4/zorro-agent. It costs 31 tokens per session (2,894 once invoked), scanned A, a copy of siyuan, MIT.

A command-line interface to the SiYuan self-hosted note system, which stores notes under your control. It uses SiYuan's API to search, read, create, update, and delete documents and blocks.

In plain words
What is it for?
Use it to search notes, read or change individual content blocks, and create or manage documents in a local or Docker-hosted SiYuan instance.
Why use it?
It lets a coding agent manage a personal or team knowledge base through repeatable commands instead of manual editing.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one.

Good fit Use it to search notes, read or change individual content blocks, and create or manage documents in a local or Docker-hosted SiYuan instance.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/braxtonrose4/zorro-agent/siyuan
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Any agent
npx skills add braxtonROSE4/zorro-agent --skill siyuan
Clone the repo
git clone --depth 1 https://github.com/braxtonROSE4/zorro-agent

Made for: Claude Code, Codex.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for siyuan

README.md
[![agentmods](https://agentmods.dev/badge/skills/braxtonrose4/zorro-agent/siyuan/github.svg)](https://agentmods.dev/skills/braxtonrose4/zorro-agent/siyuan)
Your own site
<a href="https://agentmods.dev/skills/braxtonrose4/zorro-agent/siyuan"><img src="https://agentmods.dev/badge/skills/braxtonrose4/zorro-agent/siyuan/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for siyuan

Your own site · 80×15
<a href="https://agentmods.dev/skills/braxtonrose4/zorro-agent/siyuan"><img src="https://agentmods.dev/badge/skills/braxtonrose4/zorro-agent/siyuan.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 31 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 2,894 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 1 finding. A grade says what 26 rules found in the file — not that it is safe.
Origin 95% copy Near-identical to another mod in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00031 $0.02894
Opus 5 $0.00015 $0.01447
Sonnet 5 $0.00006 $0.00579
Haiku 4.5 $0.00003 $0.00289

Measured 10d ago against content hash 914261e3de52, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-10, from the pricing page.

Security

Grade A, and why

siyuan scanned grade A with 1 finding against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 10d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Makes network callslowCapability

Not a fault in itself. Listed so you know the mod talks to something, and to what.

description: SiYuan Note API for searching, reading, creating, and managing blocks and documents in a self-hosted knowledge base via curl.
Origin

This is a copy

95% identical to siyuan — 9 lines differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

optional-skills/productivity/siyuan/SKILL.md · 298 lines

How it starts

The opening of the file, as written. The whole thing — 298 lines — stays where its author put it; the contents beside it link to each section on GitHub.

SiYuan Note API

Use the SiYuan kernel API via curl to search, read, create, update, and delete blocks and documents in a self-hosted knowledge base. No extra tools needed -- just curl and an API token.

Prerequisites

  1. Install and run SiYuan (desktop or Docker)
  2. Get your API token: Settings > About > API token
  3. Store it in ~/.zorro/.env:
    SIYUAN_TOKEN=your_token_here
    SIYUAN_URL=http://127.0.0.1:6806
    
    SIYUAN_URL defaults to http://127.0.0.1:6806 if not set.

API Basics

All SiYuan API calls are POST with JSON body. Every request follows this pattern:

curl -s -X POST "${SIYUAN_URL:-http://127.0.0.1:6806}/api/..." \
  -H "Authorization: Token $SIYUAN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"param": "value"}'

Responses are JSON with this structure:

{"code": 0, "msg": "", "data": { ... }}

code: 0 means success. Any other value is an error -- check msg for details.

ID format: SiYuan IDs look like 20210808180117-6v0mkxr (14-digit timestamp + 7 alphanumeric chars).

Quick Reference

Operation Endpoint
Full-text search /api/search/fullTextSearchBlock
SQL query /api/query/sql
Read block /api/block/getBlockKramdown
Read children /api/block/getChildBlocks
Get path /api/filetree/getHPathByID
Get attributes /api/attr/getBlockAttrs
List notebooks /api/notebook/lsNotebooks
List documents /api/filetree/listDocsByPath
Create notebook /api/notebook/createNotebook
Create document /api/filetree/createDocWithMd
Append block /api/block/appendBlock
Update block /api/block/updateBlock
Rename document /api/filetree/renameDocByID
Set attributes /api/attr/setBlockAttrs
Delete block /api/block/deleteBlock
Delete document /api/filetree/removeDocByID
Export as Markdown /api/export/exportMdContent

Read the full file on GitHub · 298 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 10d ago First seen · 298 lines · 31 tokens per session scan A 914261e3de52

Subscribe to this mod's changes

siyuan is a skill published in the GitHub repository braxtonROSE4/zorro-agent (8 stars, last pushed 4mo ago), licensed MIT. It adds 31 tokens to every session and 2,894 once invoked, about $0.0002 per session on Opus 5. A static security scan graded it A with 1 finding (makes network calls). It is 95% identical to siyuan, differing in 9 lines, and is treated as a copy.