Notes Workspace Api logo

Notes Workspace Api

Community
zhaoolee
notes-workspace-api

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

Overview

Publisherzhaoolee
Repositorynotes
Skill namenotes-workspace-api
Stars
312
Forks
25
Bundled files
3
LicenseApache-2.0
Links
  • Markdown instructions

    A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.

  • Works with any LLM

    AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.

  • 3 bundled files

    Scripts, templates, and references the model can read while it works. Files are read-only and never executed.

  • Open source

    Published by zhaoolee on GitHub. Read the source before you install it.

Installation

Install the Notes Workspace Api AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

1

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
    https://github.com/zhaoolee/notes/tree/main/skills/notes-workspace-api
  4. Enable the skill in any chat where you want it available.
Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.
2

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills
git clone --depth 1 https://github.com/zhaoolee/notes.git /tmp/notes
mkdir -p .claude/skills
cp -r /tmp/notes/skills/notes-workspace-api .claude/skills/notes-workspace-api
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Notes Workspace Api in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Notes Workspace Api on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Notes Workspace Api is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

  • Loaded only when it is needed

    The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.

  • Switch models mid-chat

    Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

锤子便签工作区 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。

Bundled files

The model reads these on demand while the skill is loaded. They are exposed as readable files and are never executed.

Frequently asked questions

What does the Notes Workspace Api AI skill do?

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

Why use Notes Workspace Api on TypingMind?

Because you install it once and use it with any model. Notes Workspace Api is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Notes Workspace Api in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/zhaoolee/notes/tree/main/skills/notes-workspace-api. TypingMind reads its SKILL.md and bundles its files and installs it as a skill you can enable per chat.

Which AI models can use Notes Workspace Api?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Notes Workspace Api?

As many as you like. As long as a model supports skills, you can use Notes Workspace Api with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Notes Workspace Api AI skill free?

Yes. It is published on GitHub by zhaoolee under the Apache-2.0 license. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇