← 返回 Skills 市场
660
总下载
3
收藏
1
当前安装
7
版本数
在 OpenClaw 中安装
/install joplin-api
功能描述
Manage Joplin notes via REST API. Use for creating, reading, updating, deleting, or searching Joplin notes programmatically.
使用说明 (SKILL.md)
Joplin API Skill
Manage Joplin notes, notebooks, and tags via Joplin Data API.
Environment Variables
| Variable | Required | Default | Description |
|---|---|---|---|
JOPLIN_BASE_URL |
No | http://localhost:41184 |
Joplin API URL |
JOPLIN_TOKEN |
Yes | - | API Token from Web Clipper |
Quick Start
1. Get API Token
- Open Joplin → Tools → Options → Web Clipper
- Enable service and copy the token
2. Test Connection
python3 joplin.py ping
Basic Commands
python3 joplin.py ping # Test connection
python3 joplin.py create --title "Title" # Create note
python3 joplin.py search "keyword" # Search
python3 joplin.py list --type notes # List notes
python3 joplin.py stats # Statistics
Security
- Import/Export restricted to workspace directory
- Sensitive system directories blocked
Documentation
references/API.md- Full API referencereferences/CONFIGURATION.md- Configuration examples
安全使用建议
This skill appears to do what it says: it is a local Joplin Data API client implemented in Python and requires a JOPLIN_TOKEN (API token) and python3 with requests and python-dotenv. Before installing, check: 1) Provide a valid JOPLIN_TOKEN and confirm whether your runtime environment will supply the SKILL.md pip install step (the registry metadata omitted required env info). 2) Review and, if needed, change JOPLIN_IMPORT_DIR/JOPLIN_EXPORT_DIR to a directory you control — the default is /root/.openclaw/workspace and the code blocks access to /home and other system dirs which may prevent using your normal home directory. 3) Confirm you trust the code bundle (it calls only your configured Joplin server URL and does not phone home); if you plan to point JOPLIN_BASE_URL at a remote host, ensure the host is trusted. Finally, if you need the skill to run on a non-root environment, adjust the default workspace paths accordingly.
功能分析
Type: OpenClaw Skill
Name: joplin-api
Version: 0.1.3
The OpenClaw AgentSkills bundle for Joplin API is classified as benign. The skill's primary function is to manage Joplin notes via its REST API, which it accomplishes using standard Python libraries like `requests` and `argparse`. Crucially, the `joplin_export.py` and `joplin_import.py` scripts implement robust path sanitization using `pathlib.Path.resolve()`, explicitly defining `ALLOWED_BASE_DIRS` (e.g., `/root/.openclaw/workspace`) and a comprehensive list of `BLOCKED_DIRS` (e.g., `/etc`, `/home`, `/bin`), effectively mitigating path traversal vulnerabilities. There is no evidence of malicious intent, data exfiltration, unauthorized execution, or prompt injection attempts in any of the files, including the `SKILL.md` instructions.
能力评估
Purpose & Capability
The skill's name and description (Joplin API management) match the included files and behavior: Python scripts call the Joplin Data API (GET/POST/PUT/DELETE) and implement create/read/update/delete/search/import/export operations. Required binary (python3) and Python dependencies (requests, python-dotenv) are appropriate for the stated purpose.
Instruction Scope
Runtime instructions and scripts only interact with the configured Joplin API base URL and local filesystem for import/export. Scripts read JOPLIN_BASE_URL and JOPLIN_TOKEN (declared in SKILL.md) and limit import/export to workspace dirs. No instructions attempt to read unrelated system state or send data to third-party endpoints. Minor oddity: SKILL.md metadata says to install pip deps, but the skill registry's top-level summary listed no required env vars — the scripts do require JOPLIN_TOKEN at runtime.
Install Mechanism
No remote downloads or archive extraction are used. The SKILL.md recommends installing Python packages via pip (requests, python-dotenv) which is expected for Python scripts. There is no suspicious install URL or arbitrary code fetch.
Credentials
Environment variables used (JOPLIN_BASE_URL, JOPLIN_TOKEN, JOPLIN_IMPORT_DIR, JOPLIN_EXPORT_DIR) are proportionate and directly tied to Joplin API usage. However, registry metadata at the top listed 'Required env vars: none' while SKILL.md marks JOPLIN_TOKEN as required — that's an inconsistency to be aware of. The default allowed workspace is /root/.openclaw/workspace and BLOCKED_DIRS includes /home, which may be unexpectedly restrictive on typical user systems.
Persistence & Privilege
The skill is not always-enabled and does not request system-wide persistence or privileges. It doesn't modify other skills' configs. Autonomous invocation is allowed by default (platform standard) but the skill doesn't request elevated platform privileges.
如何使用
- 确保已安装 OpenClaw(本地或 Docker 部署)
- 在对话框中输入安装命令:
/install joplin-api - 安装完成后,直接呼叫该 Skill 的名称或使用
/joplin-api触发 - 根据 Skill 的参数说明提供必要输入,即可获得结构化输出
版本历史
v0.1.3
Removed all .env location references from code and documentation
v0.1.2
Simplified documentation: Removed .env location details, cleaner environment variable declaration
v0.1.1
Fixed documentation inconsistencies: Added proper YAML front matter, updated CONFIG.example to use JOPLIN_BASE_URL, rewrote all documentation in English, clarified .env location (~/.openclaw/.env)
v0.1.0
Initial release: Complete rewrite following Joplin official API documentation.
v0.0.3
修复:1) 统一 metadata 和文档的环境变量要求说明 2) 添加非隐藏的 CONFIG.example 配置模板 3) 移除 pipx 建议
v0.0.2
修复:添加 allowed-tools 声明,修正 metadata YAML 格式,添加 homepage 链接
v0.0.1
Initial release: programmatic management of Joplin notes, notebooks, and tags via Data API with flexible deployment support.
- Supports create, read, update, delete, search, organize notes via command-line scripts.
- Handles notebooks and tags: create, list, rename, delete, add/remove tags, move notes between notebooks.
- Batch operations: import/export notes, batch move, backup/export all notes.
- Requires Python 3 and dependencies (requests, python-dotenv), configurable via environment variables.
- Compatible with local, Docker, or remote Joplin deployments.
元数据
常见问题
Joplin Api 是什么?
Manage Joplin notes via REST API. Use for creating, reading, updating, deleting, or searching Joplin notes programmatically. 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件,目前累计下载 660 次。
如何安装 Joplin Api?
在 OpenClaw 或 Claude Code 对话框中运行命令「/install joplin-api」即可一键安装,无需额外配置。
Joplin Api 是免费的吗?
是的,Joplin Api 完全免费(开源免费),可自由下载、安装和使用。
Joplin Api 支持哪些平台?
Joplin Api 跨平台运行,可在任意部署了 OpenClaw / Claude Code 的环境中使用(cross-platform)。
谁开发了 Joplin Api?
由 KGTAF(@killgfat)开发并维护,当前版本 v0.1.3。
推荐 Skills