siyuan

SiYuan is a privacy-first, self-hosted personal knowledge management system for creating and managing knowledge using block-level references and a Markdown/WYSIWYG editor. It supports exporting content and includes features such as search, OCR, spaced repetition, and AI writing/Q&A via external APIs (e.g., OpenAI).

Evaluated Mar 29, 2026 (0d ago)
Homepage ↗ Repo ↗ Cms self-hosted privacy-first knowledge-management notes markdown local-first electron ocr spaced-repetition pdf api docker
⚙ Agent Friendliness
18
/ 100
Can an agent use this?
🔒 Security
24
/ 100
Is it safe for agents?
⚡ Reliability
12
/ 100
Does it work consistently?

Score Breakdown

⚙ Agent Friendliness

MCP Quality
--
Documentation
--
Error Messages
--
Auth Simplicity
55
Rate Limits
0

🔒 Security

TLS Enforcement
0
Auth Strength
45
Scope Granularity
10
Dep. Hygiene
0
Secret Handling
55

Provided content mentions an access authorization code for server access and an option to bypass it via an environment variable. Details about TLS enforcement, per-endpoint API auth, rate limits, and secret handling/logging are not shown in the excerpt.

⚡ Reliability

Uptime/SLA
0
Version Stability
50
Breaking Changes
0
Error Recovery
0
AF Security Reliability

Best When

You want a self-hosted, local-first style knowledge base with rich block linking and the option to integrate OCR and (optionally) external AI services.

Avoid When

You cannot or do not want to manage server/container deployment, storage, and backups for a self-hosted system.

Use Cases

  • Self-hosted personal knowledge management with block-level links and references
  • Markdown/WYSIWYG note-taking and large-document editing
  • Web clipping, PDF annotation/links, and OCR for documents
  • Spaced repetition flashcards
  • Embedding SQL queries and rich content blocks
  • Exporting notes to Markdown/HTML/PDF/Word and sharing to other platforms

Not For

  • A managed SaaS service with turnkey hosting (it is primarily self-hosted)
  • A mobile-first workflow where all core operations are fully supported without a desktop/server backend
  • Use as a general-purpose multi-tenant API platform without appropriate deployment isolation

Interface

REST API
Yes
GraphQL
No
gRPC
No
MCP Server
No
SDK
No
Webhooks
No

Authentication

Methods: Access authorization code for server access (e.g., Docker --accessAuthCode / SIYUAN_ACCESS_AUTH_CODE) Environment-variable-based configuration for auth bypass (SIYUAN_ACCESS_AUTH_CODE_BYPASS)
OAuth: No Scopes: No

The README excerpt documents an 'access authorization code' for access to the server. It also describes an explicit bypass flag (SIYUAN_ACCESS_AUTH_CODE_BYPASS=true). The presence/absence of more granular API authentication details (e.g., per-endpoint tokens/scopes) is not shown in the provided content.

Pricing

Model: Freemium / membership-based features (per README)
Free tier: Yes
Requires CC: No

Some AI features and/or advanced functions may depend on paid membership and external API usage (not fully specified in the excerpt).

Agent Metadata

Idempotent
Unknown
Retry Guidance
Not documented

Known Gotchas

  • No MCP server is documented in the provided content; agent integration likely requires calling the documented API directly.
  • The access authorization code may be bypassable via a specific environment flag; automation should avoid enabling bypass and should treat the code as a secret.
  • Self-hosted deployment means agents should account for environment-specific configuration (workspace path, ports, container user permissions).

Alternatives

Full Evaluation Report

Comprehensive deep-dive: security analysis, reliability audit, agent experience review, cost modeling, competitive positioning, and improvement roadmap for siyuan.

AI-powered analysis · PDF + markdown · Delivered within 30 minutes

$99

Package Brief

Quick verdict, integration guide, cost projections, gotchas with workarounds, and alternatives comparison.

Delivered within 10 minutes

$3

Score Monitoring

Get alerted when this package's AF, security, or reliability scores change significantly. Stay ahead of regressions.

Continuous monitoring

$3/mo

Scores are editorial opinions as of 2026-03-29.

5347
Packages Evaluated
21056
Need Evaluation
586
Need Re-evaluation
Community Powered