joplin-mcp

joplin-mcp

A minimal MCP server that enables interaction with Joplin notes and notebooks through the local Web Clipper REST API, providing tools for search, create, update, and note management.

Category
访问服务器

README

joplin-mcp

A minimal MCP server for Joplin, built with FastMCP. Talks to Joplin's local Web Clipper REST API.

Tools

  • search_notes(query, limit=20) — full-text search
  • get_note(note_id) — fetch a note's full content
  • create_note(title, body, notebook_id) — create a new note
  • update_note(note_id, title=None, body=None) — edit an existing note
  • list_notebooks() — list notebooks, to get a notebook_id for create_note

Setup

  1. In Joplin Desktop: Tools > Options > Web Clipper, enable the service, copy the auth token shown there.
  2. Set the token as an environment variable (don't hardcode it in configs you might commit or share):
    export JOPLIN_TOKEN="paste-your-token-here"
    
    Or drop it into the .env file at the repo root (already gitignored) and pass --env-file .env to uv run instead — see below.
  3. Install uv if you don't have it.
  4. Set JOPLIN_ALLOWED_NOTEBOOKS to a comma-separated list of notebook ids and/or names (get these from list_notebooks) — see Access control below.

Running it

No manual pip install needed — uv run resolves and caches dependencies on first run.

uv run --directory /path/to/joplin-mcp joplin-mcp-server

To load JOPLIN_TOKEN (and friends) from the .env file instead of exporting them in your shell:

uv run --env-file .env --directory /path/to/joplin-mcp joplin-mcp-server

Wiring into an MCP client

Both approaches below point uv at the .env file rather than duplicating JOPLIN_TOKEN/JOPLIN_ALLOWED_NOTEBOOKS into the client config — one source of truth for secrets.

Claude Code

claude mcp add joplin -s user -- uv run --env-file /path/to/joplin-mcp/.env --directory /path/to/joplin-mcp joplin-mcp-server

-s user registers it at user scope, so it's available in every Claude Code session, not just this repo. Verify with claude mcp get joplin; remove with claude mcp remove joplin -s user.

Claude Desktop

Edit ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) or %APPDATA%\Claude\claude_desktop_config.json (Windows), adding:

{
  "mcpServers": {
    "joplin": {
      "command": "uv",
      "args": ["run", "--env-file", "/path/to/joplin-mcp/.env", "--directory", "/path/to/joplin-mcp", "joplin-mcp-server"]
    }
  }
}

Fully quit and restart Claude Desktop afterward — it only picks up config changes on launch. This is the schema documented at support.claude.com and modelcontextprotocol.io. Some Claude Desktop builds manage MCP servers through a Settings UI (Extensions/Connectors) instead of this file directly — check there first if the file on disk doesn't have an mcpServers key already.

Migrating to uvx later

Once this repo is stable and pushed, the local uv run --directory ... invocation above can be replaced with:

uvx --from git+https://github.com/johnsarie27/joplin-mcp@<pinned-sha> joplin-mcp-server

pinning <pinned-sha> to a specific commit per the SHA-pinning convention, so client configs aren't silently pulling main on every run. No local checkout needed at that point — just swap the command/args in whichever client config above to uvx/--from git+... instead of uv/run --env-file ... --directory ....

Testing standalone (recommended before wiring into a client)

npx @modelcontextprotocol/inspector uv run --env-file .env --directory /path/to/joplin-mcp joplin-mcp-server

This opens a local web UI where you can call each tool manually and see the raw request/response before trusting it to a model.

Access control

search_notes, get_note, create_note, and update_note are scoped to notebooks listed in JOPLIN_ALLOWED_NOTEBOOKS (comma-separated notebook ids and/or names). This is fail-closed: if the variable is unset, empty, or none of its entries match a real notebook, all four tools refuse to operate. list_notebooks is unaffected since it only returns notebook metadata, not note content, and doubles as the way to find the ids/names to allowlist in the first place.

Name matching is case-insensitive (Tech, tech, and TECH are equivalent) and resolved against the live notebook list on each call, so a rename takes effect immediately. Since Joplin doesn't require notebook names to be unique (nested notebooks can share a title), a name that matches more than one notebook allows all of them — use the notebook id instead (from list_notebooks) if you need to scope to just one of several same-named notebooks.

Set JOPLIN_ALLOWED_NOTEBOOKS=* to explicitly allow all notebooks. This is a deliberate opt-in, distinct from leaving the variable unset.

Out-of-scope access raises a NotebookAccessError with a message naming the notebook, distinct from a JoplinError (an actual Joplin API failure).

Notes on this build

  • Requires Joplin Desktop running with the Web Clipper service enabled (i.e. Joplin itself must be open — this doesn't run Joplin headlessly).
  • JOPLIN_HOST / JOPLIN_PORT env vars override the defaults (localhost / 41184) if needed.
  • Errors from the Joplin API surface as JoplinError with the raw status/body — check these first if a tool call fails.

References

Related projects

推荐服务器

Baidu Map

Baidu Map

百度地图核心API现已全面兼容MCP协议,是国内首家兼容MCP协议的地图服务商。

官方
精选
JavaScript
Playwright MCP Server

Playwright MCP Server

一个模型上下文协议服务器,它使大型语言模型能够通过结构化的可访问性快照与网页进行交互,而无需视觉模型或屏幕截图。

官方
精选
TypeScript
Magic Component Platform (MCP)

Magic Component Platform (MCP)

一个由人工智能驱动的工具,可以从自然语言描述生成现代化的用户界面组件,并与流行的集成开发环境(IDE)集成,从而简化用户界面开发流程。

官方
精选
本地
TypeScript
Audiense Insights MCP Server

Audiense Insights MCP Server

通过模型上下文协议启用与 Audiense Insights 账户的交互,从而促进营销洞察和受众数据的提取和分析,包括人口统计信息、行为和影响者互动。

官方
精选
本地
TypeScript
VeyraX

VeyraX

一个单一的 MCP 工具,连接你所有喜爱的工具:Gmail、日历以及其他 40 多个工具。

官方
精选
本地
graphlit-mcp-server

graphlit-mcp-server

模型上下文协议 (MCP) 服务器实现了 MCP 客户端与 Graphlit 服务之间的集成。 除了网络爬取之外,还可以将任何内容(从 Slack 到 Gmail 再到播客订阅源)导入到 Graphlit 项目中,然后从 MCP 客户端检索相关内容。

官方
精选
TypeScript
Kagi MCP Server

Kagi MCP Server

一个 MCP 服务器,集成了 Kagi 搜索功能和 Claude AI,使 Claude 能够在回答需要最新信息的问题时执行实时网络搜索。

官方
精选
Python
e2b-mcp-server

e2b-mcp-server

使用 MCP 通过 e2b 运行代码。

官方
精选
Neon MCP Server

Neon MCP Server

用于与 Neon 管理 API 和数据库交互的 MCP 服务器

官方
精选
Exa MCP Server

Exa MCP Server

模型上下文协议(MCP)服务器允许像 Claude 这样的 AI 助手使用 Exa AI 搜索 API 进行网络搜索。这种设置允许 AI 模型以安全和受控的方式获取实时的网络信息。

官方
精选