siyuan-mcp-server: Instructions file for Codex

AGENTS.md

siyuan-mcp-server AGENTS.md is an instructions file for Codex, OpenCode from Fromsko/siyuan-mcp-server. It costs 758 tokens per session, scanned A, original, ISC.

Repository instructions for siyuan-mcp-server, a service that connects an AI agent with SiYuan. They define contribution, testing, build, release, formatting, and version-compatibility rules.

In plain words
What is it for?
Use them when adding or changing SiYuan API endpoints, running builds and tests, formatting commits, checking compatibility, or preparing a release.
Why use it?
They make the project's required checks and conventions clear, reducing mistakes when changing or releasing the server.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: the file is AGENTS.md.

This is Fromsko/siyuan-mcp-server's own configuration. It tells Codex and OpenCode how to work on siyuan-mcp-server itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything siyuan-mcp-server configures →

Reuse

Borrowing it

Nothing to install: this file belongs to Fromsko/siyuan-mcp-server. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/Fromsko/siyuan-mcp-server/main/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/Fromsko/siyuan-mcp-server

Made for: Codex, OpenCode.

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-mcp-server AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/fromsko/siyuan-mcp-server/agents-md/github.svg)](https://agentmods.dev/instructions/fromsko/siyuan-mcp-server/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/fromsko/siyuan-mcp-server/agents-md"><img src="https://agentmods.dev/badge/instructions/fromsko/siyuan-mcp-server/agents-md/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-mcp-server AGENTS.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/fromsko/siyuan-mcp-server/agents-md"><img src="https://agentmods.dev/badge/instructions/fromsko/siyuan-mcp-server/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 758 This file is loaded in full into every session.
When invoked 758 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found 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.00758 $0.00758
Opus 5.5 $0.00303 $0.00303
Sonnet 5.5 $0.00152 $0.00152
Haiku 4.5 $0.00076 $0.00076

Measured 2mo ago against content hash 17e0202d0e61, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

siyuan-mcp-server AGENTS.md scanned grade A with 0 findings 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 2mo 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.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 107 lines

What it actually says

siyuan-mcp-server 开发规范

本文件面向 AI 代理和人类开发者,规范本仓库的所有操作。

提交规范

格式

<emoji> <type>: <简短描述>

详细描述:
- 分点 1
- 分点 2

Emoji 对照

Emoji Type 用途
🐛 fix Bug 修复
✨ feat 新功能
📝 docs 文档变更
🔧 chore 构建/工具/版本号
♻️ refactor 重构
⚡ perf 性能优化
✅ test 增加测试
🔒 security 安全修复

示例

🐛 fix: MCP 协议违规修复

详细描述:
- index.ts: console.log 改为仅在 NODE_ENV=development 时输出到 stderr
- client.ts: 错误日志尊重运行模式
- version.ts: 增强 readFileSync 健壮性

✨ feat: 新增 5 个 filetree 端点

详细描述:
- 新增 removeDoc 文档删除命令
- 新增 moveDocs 文档移动命令
- 新增 getHPathByPath/getHPathByID 路径查询

开发流程

提交前必须

  1. ✅ npm run build 通过(TypeScript 编译无错误)
  2. ✅ npm test 全部通过
  3. ✅ 对比官方 API 文档确认端点存在
  4. ❌ 禁止未经测试直接推送

版本发布流程

# 1. 确认构建和测试
npm run build && npm test

# 2. 提交代码
git add -A
git commit -m "🐛 fix: ..."

# 3. 更新版本号
sed -i 's/"version": "x.y.z"/"version": "NEW"/' package.json
git add package.json
git commit -m "🔧 chore: bump version to NEW"

# 4. 打 tag + 推送
git tag vNEW
git push origin main
git push origin vNEW

思源版本兼容

当前兼容范围记录在 package.json 的 siyuan 字段中:

{
  "siyuan": {
    "minVersion": "3.0.0",
    "maxVersion": "3.x",
    "apiDoc": "https://github.com/siyuan-note/siyuan/blob/master/docs/API.md"
  }
}

每次对比官方 API 文档后,更新兼容版本范围。

API 对比方法

  1. 获取官方文档:https://raw.githubusercontent.com/siyuan-note/siyuan/master/docs/API.md
  2. 提取所有 /api/ 路径
  3. 逐一对比代码中的 createHandler('...') 调用
  4. 标注:✅ 匹配 / ❌ 不存在 / ⚠️ 参数不匹配

禁止事项

  • ❌ 直接推送未测试的代码
  • ❌ 使用不存在的 API 端点(必须先查官方文档)
  • ❌ 在 stdout 输出非 JSON-RPC 内容
  • ❌ 使用 console.log 代替 console.error 输出日志
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. 2mo ago First seen · 107 lines · 758 tokens per session scan A 17e0202d0e61

Subscribe to this mod's changes

siyuan-mcp-server AGENTS.md is an instructions file published in the GitHub repository Fromsko/siyuan-mcp-server (40 stars, last pushed 3mo ago), licensed ISC. It adds 758 tokens to every session, about $0.0030 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

siyuan-mcp-server AGENTS.md compared with instructions from other repositories

siyuan-mcp-server AGENTS.md next to 6 instructions from other repositories
ModTypeStarsLast pushLicenceScanTokensWorks with
siyuan-mcp-server AGENTS.mdFromsko/siyuan-mcp-serverInstructions file403mo agoISCA758Codex, OpenCode
vscode buildNext.instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA9,719GitHub Copilot
next.js AGENTS.mdvercel/next.jsInstructions file143kyesterdayMITA7,461Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchainInstructions file149kyesterdayMITA4,680Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA5,516GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA3,093GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harnessInstructions file274k2d agoMITA4,313Codex, OpenCode