/install joplin-notes
Joplin Notes Skill
This skill provides programmatic access to a Joplin database synchronized via WebDAV.
How it Works
Joplin stores notes and notebooks as .md files in a flat directory. They are linked via metadata at the end of the file (id, parent_id, type_).
- Title: The first line of the file is the title of the note or notebook.
- Notebook: A special file type (
type_: 2) that serves as a container for notes. - Note: A standard file (
type_: 1) assigned to a notebook viaparent_id.
Available Scripts
The scripts are located in scripts/ and require the following environment variables:
JOPLIN_PASSWORD: The password for WebDAV access.JOPLIN_ACCOUNT: The username for Joplin (e.g.,openclaw).JOPLIN_WEBDAV_PATH: The full path to the Joplin directory on the WebDAV server.
1. List Notes (list_notes.py)
Outputs the entire structure of notebooks and their contained notes.
- Usage:
python3 scripts/list_notes.py
2. Get Note Content (get_note.py)
Reads the content of a specific note by its ID.
- Usage:
python3 scripts/get_note.py \x3Cnote_id>
3. Upsert Note/Notebook (upsert_note.py)
Updates an existing note or creates a new one. Supports notebooks via the type parameter.
- Usage:
python3 scripts/upsert_note.py \x3Cnote_id|new> \x3Cparent_id> \x3Ccontent_file> [type (1=note, 2=notebook)]
4. Create Notebook (create_notebook.py)
Creates a new notebook.
- Usage:
python3 scripts/create_notebook.py \x3Ctitle> [parent_notebook_id]
Workflow Examples
Query Structure
exec("python3 /home/openclaw/.openclaw/workspace/skills/joplin-notes/scripts/list_notes.py")- Analyze the output to find the desired
note_idornotebook_id.
Read Note Content
exec("python3 /home/openclaw/.openclaw/workspace/skills/joplin-notes/scripts/get_note.py \x3Cnote_id>")
Edit or Create Note
- Download the current content with
get_note.py(if editing). - Create a temporary file with the new content (include the title in the first line).
- Call
upsert_note.py.
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install joplin-notes - After installation, invoke the skill by name or use
/joplin-notes - Provide required inputs per the skill's parameter spec and get structured output
What is Joplin Notes?
Interface for managing Joplin notes via WebDAV. Allows listing notebooks and notes, reading content (first line = title), and creating or updating notes and... It is an AI Agent Skill for Claude Code / OpenClaw, with 115 downloads so far.
How do I install Joplin Notes?
Run "/install joplin-notes" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is Joplin Notes free?
Yes, Joplin Notes is completely free, licensed under MIT-0. You can download, install and use it at no cost.
Which platforms does Joplin Notes support?
Joplin Notes is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created Joplin Notes?
It is built and maintained by Martin004 (@martin004); the current version is v1.0.0.