Agent skill

Notes Workspace API

by zhaoolee in zhaoolee/notes

连接明确配置的锤子便签服务,查询和维护当前账号的云端工作区。支持便签列表、全文查询、新增、更新、软删除、恢复、显式永久删除、文件夹分类、星标和置顶;用户提到用 Hermes 或 AI 管理锤子便签、查找便签、写入 Markdown、整理分类、收藏、置顶或处理回收站时使用。优先使用 NOTESAPITOKEN;仅在 Token 缺失时用用户名和密码自动申请 Token 并安全更新 .env。

Apache-2.0Auto-check: notesKnowledge Management

Install Notes Workspace API

skills CLI
$ npx skills add zhaoolee/notes --skill notes-workspace-api -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install zhaoolee/notes notes-workspace-api --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/zhaoolee/notes.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/notes-workspace-api .claude/skills/notes-workspace-api && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
notes-workspace-api
GitHub stars
249
Token cost
~502 tokens
SKILL.md length
50 words
Files
5 (incl. scripts, references)
Skills in repo
2
Repo updated
First seen
Licence
Apache-2.0

At a glance

连接明确配置的锤子便签服务,查询和维护当前账号的云端工作区。支持便签列表、全文查询、新增、更新、软删除、恢复、显式永久删除、文件夹分类、星标和置顶;用户提到用 Hermes 或 AI 管理锤子便签、查找便签、写入 Markdown、整理分类、收藏、置顶或处理回收站时使用。优先使用 NOTESAPITOKEN;仅在 Token 缺失时用用户名和密码自动申请 Token 并安全更新 .env。

  • Tasks that involve Note-taking
  • SKILL.md covers 配置认证, 执行命令 and 保持并发安全
  • Runs JavaScript scripts from its folder; calls node; needs NOTES_API_TOKEN and NOTES_API_PASSWORD

What it does

Notes Workspace API is an agent skill from zhaoolee/notes. 连接明确配置的锤子便签服务,查询和维护当前账号的云端工作区。支持便签列表、全文查询、新增、更新、软删除、恢复、显式永久删除、文件夹分类、星标和置顶;用户提到用 Hermes 或 AI 管理锤子便签、查找便签、写入 Markdown、整理分类、收藏、置顶或处理回收站时使用。优先使用 NOTESAPITOKEN;仅在 Token 缺失时用用户名和密码自动申请 Token 并安全更新 .env。

Its SKILL.md is about 500 tokens, which your agent loads only when the skill is triggered. The skill folder holds 7 other files, including scripts and reference files (for example `agents/openai.yaml` and `references/workspace-api.md`).

It sits in Knowledge Management, covering Note-taking. The repository describes itself as: 开源版锤子便签,复刻锤科美学,一键Docker私有化部署,支持skill调用,支持dsh plugin,支持多租户,一键生成公众号格式,支持导出便签为图片. The licence is Apache-2.0.

When your agent uses it

  • Tasks that involve Note-taking

Example prompts

  • “/notes-workspace-api”

Requirements

  • Node.js
  • A credential in NOTES_API_TOKEN

What it can do on your machine

Read from SKILL.md and the folder at commit d07a926. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Ships 1 file in scripts/ (JavaScript), which the agent can run.

    Shell commands in SKILL.md call:

    • node

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names these keys or tokens, usually read from environment variables:

    • NOTES_API_TOKEN
    • NOTES_API_PASSWORD

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Notes Workspace API loads about 502 tokens when it runs, and up to ~1.4k if it reads all its reference files. Until then it costs about 55 tokens; SKILL.md has 50 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~55
When it runs · the whole SKILL.md, loaded when a task matches
~502
With references · SKILL.md plus every file in references/, read only if the agent opens them
~1.4k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check: notes

The automated check noted patterns worth knowing about, such as sudo or a known installer.

  • NoteMentions a .env fileSKILL.md:3
    OKEN;仅在 Token 缺失时用用户名和密码自动申请 Token 并安全更新 .env。
  • NoteMentions a .env fileSKILL.md:12
    方明确提供 `NOTES_API_BASE_URL`。优先从 Skill 目录 `.env` 读取:
  • NoteMentions a .env fileSKILL.md:27
    源 `/api/auth/skill-token` 申请 Token,原子更新 `.env`,并移除用户名和

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); the scripts in this folder are not scanned.

SKILL.md

The full file from zhaoolee/notes at commit d07a926, republished under its Apache-2.0 licence (© zhaoolee). 50 words, ~502 tokens.

Download SKILL.mdSave it as .claude/skills/notes-workspace-api/SKILL.md (or your agent's skills folder). This skill also uses 4 other files; get the full folder from GitHub.
name
notes-workspace-api
description
连接明确配置的锤子便签服务,查询和维护当前账号的云端工作区。支持便签列表、全文查询、新增、更新、软删除、恢复、显式永久删除、文件夹分类、星标和置顶;用户提到用 Hermes 或 AI 管理锤子便签、查找便签、写入 Markdown、整理分类、收藏、置顶或处理回收站时使用。优先使用 NOTES_API_TOKEN;仅在 Token 缺失时用用户名和密码自动申请 Token 并安全更新 .env。

锤子便签工作区 API

通过服务端 API 管理登录账号自己的云端便签,不在本地维护另一份工作区。

配置认证

要求调用方明确提供 NOTES_API_BASE_URL。优先从 Skill 目录 .env 读取:

dotenv
NOTES_API_BASE_URL=https://notes.example.com
NOTES_API_TOKEN=notes_sk_v1.xxx

如果没有 Token,可在首次运行前临时配置:

dotenv
NOTES_API_BASE_URL=https://notes.example.com
NOTES_API_USERNAME=your-account
NOTES_API_PASSWORD=your-password

脚本会向同源 /api/auth/skill-token 申请 Token,原子更新 .env,并移除用户名和 密码。Token 已存在时不得回退到账号密码;Token 失效时先告知用户删除或更换旧 Token,不要静默重新授权。不要输出、记录或提交任何凭据。

执行命令

从 Skill 目录运行脚本。Hermes 中使用 ${HERMES_SKILL_DIR}:

bash
node ${HERMES_SKILL_DIR}/scripts/notes_api.mjs list
node ${HERMES_SKILL_DIR}/scripts/notes_api.mjs list --query 关键词
node ${HERMES_SKILL_DIR}/scripts/notes_api.mjs get --note-id NOTE_ID
node ${HERMES_SKILL_DIR}/scripts/notes_api.mjs add --markdown-file /abs/note.md
node ${HERMES_SKILL_DIR}/scripts/notes_api.mjs update --note-id NOTE_ID --markdown-file /abs/note.md
node ${HERMES_SKILL_DIR}/scripts/notes_api.mjs delete --note-id NOTE_ID
node ${HERMES_SKILL_DIR}/scripts/notes_api.mjs restore --note-id NOTE_ID
node ${HERMES_SKILL_DIR}/scripts/notes_api.mjs folders
node ${HERMES_SKILL_DIR}/scripts/notes_api.mjs folder-create --name 工作
node ${HERMES_SKILL_DIR}/scripts/notes_api.mjs classify --note-id NOTE_ID --folder 工作
node ${HERMES_SKILL_DIR}/scripts/notes_api.mjs star --note-id NOTE_ID --state on
node ${HERMES_SKILL_DIR}/scripts/notes_api.mjs pin --note-id NOTE_ID --state on

先执行 list、get 或 folders 取得真实 ID,不要猜测。新增或更新优先使用 --markdown-file。普通 delete 只移入回收站;仅在用户明确要求不可恢复删除时, 才对回收站便签执行 delete --permanent。

保持并发安全

写操作会提交服务端返回的 expectedUpdatedAt。遇到 HTTP 409 时让脚本自动重读并 最多重试四次,不要手工覆盖整个工作区。

需要完整参数、分类模型或数据边界时读取 references/workspace-api.md。

© zhaoolee, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 4 other files (scripts, references) in skills/notes-workspace-api of zhaoolee/notes.

  • SKILL.md
  • .env.example
  • agents/openai.yaml
  • references/workspace-api.md
  • scripts/notes_api.mjs

Open the folder on GitHubat commit d07a926

Compare with similar skills

Notes Workspace API next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Notes Workspace API compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Notes Workspace API this skillzhaoolee/notes249—~502Automated safety check: NotesApache-2.0
Qmdalsk1992/CloddsBot2.9k3 repos~1.2kAutomated safety check: PassMIT
Obsidian Canvas BoardsAgriciDaniel/claude-obsidian15k—~1.4kAutomated safety check: PassMIT
LLM Wikilewislulu/llm-wiki-skill655—~3.7kAutomated safety check: PassNone
Para Memory Filespaperclipai/paperclip99k1 repos~909Automated safety check: PassMIT
Add Frontmatterheyitsnoah/claudesidian2.6k—~951Automated safety check: PassMIT

Similar skills

  • Qmd

    alsk1992/CloddsBot

    Local hybrid search for markdown notes and docs. An agent skill from alsk1992/CloddsBot.

    2.9k GitHub starsUsed in 3 repos~1.2k tokens
    Knowledge ManagementAuto-check passed
  • Obsidian Canvas Boards

    AgriciDaniel/claude-obsidian

    Creates, inspects and updates Obsidian JSON Canvas boards in a vault, with text, file, link, group and edge nodes, using safe recoverable edits.

    15k GitHub stars~1.4k tokensUpdated 28 days ago
    Knowledge ManagementAuto-check passed
  • LLM Wiki

    lewislulu/llm-wiki-skill

    Build and maintain a Karpathy-style LLM knowledge base — a self-compiling Obsidian markdown wiki where an Agent ingests raw sources, compiles cross-linked concept/entity/summary pages, answers…

    655 GitHub stars~3.7k tokensUpdated 5 mo ago
    Knowledge ManagementAuto-check passed
  • Para Memory Files

    paperclipai/paperclip

    Use a file-based PARA memory system to store, retrieve, and organize durable knowledge across sessions.

    99k GitHub starsUsed in 1 repo~909 tokens
    Knowledge ManagementAuto-check passed
  • Add Frontmatter

    heyitsnoah/claudesidian

    Add or update YAML frontmatter properties to enhance Obsidian note organization.

    2.6k GitHub stars~951 tokensUpdated 6 mo ago
    Knowledge ManagementAuto-check passed
  • Obsidian Bases Editor

    AgriciDaniel/claude-obsidian

    Explains, drafts and validates Obsidian Bases .base files, building filters, formulas and table, card or list views, and applying edits only through one inspected transaction.

    15k GitHub stars~1.2k tokensUpdated 28 days ago
    Knowledge ManagementAuto-check passed

More from zhaoolee/notes

  • Notes Export API

    zhaoolee/notes

    通过 Token 或首次使用的用户名与密码连接调用方明确配置的锤子便签服务,管理当前账号的云端工作区并导出内容。支持便签列表与全文查询、新增、更新 Markdown、软删除、回收站恢复、显式永久删除、文件夹分类、星标、置顶、生成可粘贴到微信公众号的富文本 HTML,以及把 Markdown 或本地 .md 文件导出为带图的锤子便签长图 PNG;导出支持 default…

    249 GitHub stars~1.1k tokensUpdated yesterday
    Auto-check: notes

Questions about Notes Workspace API

What does Notes Workspace API do?

连接明确配置的锤子便签服务,查询和维护当前账号的云端工作区。支持便签列表、全文查询、新增、更新、软删除、恢复、显式永久删除、文件夹分类、星标和置顶;用户提到用 Hermes 或 AI 管理锤子便签、查找便签、写入 Markdown、整理分类、收藏、置顶或处理回收站时使用。优先使用 NOTESAPITOKEN;仅在 Token 缺失时用用户名和密码自动申请 Token 并安全更新 .env。. Notes Workspace API is an agent skill from zhaoolee/notes.

When should I use Notes Workspace API?

Notes Workspace API fits situations like: tasks that involve Note-taking.

How do I install Notes Workspace API in Claude Code?

Run `npx skills add zhaoolee/notes --skill notes-workspace-api -a claude-code`. Or copy the skill folder (skills/notes-workspace-api in zhaoolee/notes) into .claude/skills/notes-workspace-api in your project. Claude Code loads it when a task matches its description.

How do I install Notes Workspace API in Codex?

Run `npx skills add zhaoolee/notes --skill notes-workspace-api -a codex`. Or copy the skill folder (skills/notes-workspace-api in zhaoolee/notes) into .agents/skills/notes-workspace-api in your project. Codex loads it when a task matches its description.

Can I use Notes Workspace API in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add zhaoolee/notes --skill notes-workspace-api -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/notes-workspace-api, .gemini/skills/notes-workspace-api, .github/skills/notes-workspace-api and .opencode/skills/notes-workspace-api in your project.

What does Notes Workspace API need to run?

Going by SKILL.md and its folder, Notes Workspace API needs JavaScript for the scripts in its folder, the command-line tools its instructions call (node) and credentials named NOTES_API_TOKEN and NOTES_API_PASSWORD. Our summary lists: Node.js; A credential in NOTES_API_TOKEN.

Does Notes Workspace API access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Notes Workspace API safe to install?

Our automated static check of SKILL.md found notes only (mentions a .env file), nothing it rates as a warning. It is not a guarantee. The check reads SKILL.md only: the scripts in the folder are not scanned, so read them before running anything.

What licence does Notes Workspace API use?

Notes Workspace API is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Notes Workspace API use?

About 502 tokens (SKILL.md is roughly 2k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 868 tokens, read only when the agent opens those files.

What are the alternatives to Notes Workspace API?

Skills that share tags, products or a category with Notes Workspace API: Qmd (alsk1992/CloddsBot, 2.9k stars), Obsidian Canvas Boards (AgriciDaniel/claude-obsidian, 15k stars), LLM Wiki (lewislulu/llm-wiki-skill, 655 stars) and Para Memory Files (paperclipai/paperclip, 99k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Notes Workspace API?

zhaoolee (a GitHub user) maintains it in zhaoolee/notes, which has 249 GitHub stars. The repository holds 2 skills in this directory. The repository was last updated on October 8, 2026.

Source: zhaoolee/notes on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.